AS/400 Report Splitter Version 3.00 User Guide

AS/400 Report Splitter Version 3.00

User Guide

By RJS Software Systems, Inc.Revision Version 3.27

RJS Software SystemsP.O. Box 1408

Burnsville, MN 55337(612) 822-0412 Voice

(612) 822-1364 FaxEmail

(Internet) [email protected](WWW) http://www.rjssoft.com

ii

Copyright

© 1992-2000 by RJS Software Systems. All rights reserved. This manual and the software described in it arecopyrighted with all rights reserved. No part of this publication may be reproduced, transmitted, transcribed, storedin a retrieval system or translated into any language in any form by any means without the written permission of RJSSoftware Systems.

Trademarks

AS/400 Report Splitter ™ is a trademark of RJS Software Systems. Brand names and product names are trademarksor registered trademarks of their respective companies.

Printed in the USA

AS/400 Report Splitter Version 3.00 Users Guide Contents •••• i

Contents

Overview 1Introduction................................................................................................................................1Licensing Information ................................................................................................................2Technical Support ......................................................................................................................2

For Technical Support with AS/400 Report Splitter ....................................................2Contact Information ...................................................................................................................2

Chapter 1: Installation 3Introduction................................................................................................................................3AS/400 Prerequisites for AS/400 Report Splitter.......................................................................3AS/400 Installation.....................................................................................................................3

AS/400 Installation Using RSTLIB command.............................................................3AS/400 Installation Using FTP ....................................................................................3

AS/400 User Authorization Code Entry.....................................................................................3Entering AS/400 Report Splitter Access Code.............................................................3Entering Operating System Specific Settings...............................................................4

Deinstallation of AS/400 Report Splitter ...................................................................................4Removing AS/400 Report Splitter from an AS/400.....................................................4

Chapter 2: Getting Started 5Introduction................................................................................................................................5Installing the AS/400 Report Splitter Software ..........................................................................5Overview of Report Splitting Process ........................................................................................5How to Run the Report Splitter Process.....................................................................................6

Interactively using Work with Report Splitter Option .................................................6Programmatically using the Report Splitter CL Command..........................................6Automatically via the Output Queue Monitor ..............................................................6

Available Report Splitting Methods...........................................................................................6Distribute a Copy of the Entire Report.........................................................................6Distribute a Copy of the Selected Page Range.............................................................7Decollate a Single Report into Multiple Reports .........................................................7Scan Report for a String and Distribute a Copy of the Entire Report ..........................7Extract Selected Pages based on Criteria within Report ..............................................7Distribute only the Last Page of a Report ....................................................................7Distribute a report using Report Distribution Criteria..................................................7

Assigning Email Addresses to a Report .....................................................................................7Flow for Interactively Splitting a Report....................................................................................8Flow for Automatic Report Processing ......................................................................................8Flow for Embedding the Report Splitter Command in a Program..............................................8Identifying Splitting Criteria within a Report.............................................................................9Sample AS/400 Report...............................................................................................................9

Generating the Sample Report ...................................................................................10

ii •••• Contents AS/400 Report Splitter Version 3.00 Users Guide

Sample Report Characteristics .................................................................................. 10Manually Splitting your First Report....................................................................................... 11Manually Splitting a report by Page Range ............................................................................. 12Manually Decollating a Report each time Criteria Changes.................................................... 13Manually Distributing an Entire Report if Selected Criteria Found ........................................ 14Manually Distributing a Selected Section of a Report............................................................. 15Manually Distributing the Last Page of a Report .................................................................... 17Setting up Report Distribution Criteria Entries ....................................................................... 17Manually Splitting a Report using Report Distribution Criteria Table.................................... 20Manually Distributing a report and Embedding an Email Address ......................................... 20Automatically Splitting Reports using Output Queue Monitor................................................ 22Embedding Report Splitter Command in User Written Program ............................................ 22Running the Report Splitter in a CL job stream ...................................................................... 22CL Sample Program Code....................................................................................................... 22Creating AS/400 Reports with Unique Spool File Names....................................................... 23Merging Multiple Reports into a Single Spool File................................................................. 24What’s Next ?.......................................................................................................................... 24

Chapter 3: Available Menus 25Introduction ............................................................................................................................. 25Getting to the Main Menu ....................................................................................................... 25Available Options.................................................................................................................... 26

Option 1 – Enter AS/400 Report Splitter License Code............................................ 26Option 2 – Enter OS/400 Settings ............................................................................. 26Option 3 – Select and Split Reports Interactively ..................................................... 26Option 4 – Run Report Splitter Output Queue Monitor - RPTMON ........................ 26Option 5 – Submit Report Splitter Output Queue Monitor to Batch......................... 26Option 6 – Report Splitter Command - RPTSPLIT .................................................. 26Option 7 –Report Splitter Spool Merge Command - RPTMRG ............................... 26Option 8 – Report Splitter Reprint Spool File Utility - RPTREPRINT .................... 26Option 9 –Generate Report Splitter Sample AS/400 Report - RPTTEST................. 26Option 20 – Report Splitter Distribution Entry ......................................................... 26Option 21 – Report Splitter Distribution Table Listing............................................. 27Option 22 – Copy Report Distribution Entries.......................................................... 27

Chapter 4: Entering Report Splitter Distribution Criteria 29Introduction ............................................................................................................................. 29Getting to the Report Splitter Distribution Entry..................................................................... 30Fields presented on the Report Distribution Main Selection Screen ....................................... 30Fields presented on the Report Distribution Detail Entry Screen............................................ 30Report Distribution Table Maintenance Modes ...................................................................... 34Sample Settings using the *NOSPLIT option ......................................................................... 35Sample Settings using the *PAGERANGE option.................................................................. 36Sample Settings using the *ALL option .................................................................................. 37Sample Settings using the *SCANHDR option ....................................................................... 38Sample Settings Scanning for Selected Criteria ...................................................................... 39Sample Settings using the *LASTPAGE option...................................................................... 40

Chapter 5 – AS/400 Commands 41Introduction ............................................................................................................................. 41RPTMON: Report Splitter Output Queue Monitor ................................................................. 41

Description................................................................................................................ 41

AS/400 Report Splitter Version 3.00 Users Guide Contents •••• iii

Command Parameters ................................................................................................42Spool file run option ..................................................................................................42After processing spool option ....................................................................................42Source output queue...................................................................................................42Destination output queue ...........................................................................................43Destination user identifier ..........................................................................................43Run mode...................................................................................................................43Submit to job queue ...................................................................................................43Routing data ...............................................................................................................43Delay processing or run once.....................................................................................43Delay between cycles.................................................................................................44Time to end program..................................................................................................44Spool file distribution group ......................................................................................44Move to output queue ................................................................................................44Select spool files ........................................................................................................44Spool selection criteria...............................................................................................44Validate Directory Entries .........................................................................................44Print Audit Listing .....................................................................................................45

WRKSPLIT: Work with Report Splitter ..................................................................................45Description.................................................................................................................45Command Parameters ................................................................................................46Output Queue/Library ................................................................................................46Function Keys ............................................................................................................47Screen Selection Parameters for RPTSPLIT..............................................................47Compare data line ......................................................................................................49Beginning compare data column................................................................................49Ending compare data column.....................................................................................49Print Banner Page ......................................................................................................50Banner Page Test .......................................................................................................50

RPTSPLIT: AS/400 Report Splitter Command........................................................................50Description.................................................................................................................50Command Parameters ................................................................................................51Spool file name ..........................................................................................................51Job Name/User Name/Job Number............................................................................51Spool File Number.....................................................................................................51Comparison data range definition ..............................................................................51Beginning compare data.............................................................................................52Ending compare data..................................................................................................52Multiple compare occurrences ...................................................................................52Compare data line ......................................................................................................53Beginning compare data column................................................................................53Ending compare data column.....................................................................................53Starting page ..............................................................................................................53Ending page ...............................................................................................................53Destination output queue ...........................................................................................53Destination user identifier ..........................................................................................53Print Banner Page ......................................................................................................54Banner Page Test .......................................................................................................54Spool File Distribution Group....................................................................................54Validate Directory Entries .........................................................................................54

RPTMRG: Report Splitter Merge Command...........................................................................54Description.................................................................................................................54Command Parameters ................................................................................................55Source output queue...................................................................................................55Destination output queue ...........................................................................................55

iv •••• Contents AS/400 Report Splitter Version 3.00 Users Guide

Destination user identifier ......................................................................................... 55Print Banner Page ..................................................................................................... 55Banner Page Text ...................................................................................................... 55Validate Directory Entries......................................................................................... 56Select spool file......................................................................................................... 56Select user data ......................................................................................................... 56Select user id ............................................................................................................. 56Select job name ......................................................................................................... 56Select form type ........................................................................................................ 56New spool file ........................................................................................................... 56New user data............................................................................................................ 56New form type........................................................................................................... 56After processing spool option ................................................................................... 56Move to output queue ............................................................................................... 57

RPTNUM: Retrieve Spool File Name/Number....................................................................... 57Description................................................................................................................ 57Command Parameters ............................................................................................... 57Spool file name ......................................................................................................... 57Job Name/User Name/Job Number........................................................................... 57Spool File Number .................................................................................................... 57Return Spool File ...................................................................................................... 58Return Job Name....................................................................................................... 58Return Job User......................................................................................................... 58Return Job Number ................................................................................................... 58Return Spool Number ............................................................................................... 58

RPTREPRINT: Reprint Spool file .......................................................................................... 58Description................................................................................................................ 58Spool file name ......................................................................................................... 58Job Name/User Name/Job Number........................................................................... 59Spool File Number .................................................................................................... 59Change printer attributes ........................................................................................... 59

RJSWRKOUTQ: RJS Work with Output Queue .................................................................... 59Description................................................................................................................ 59Command Parameters ............................................................................................... 60Output Queue/Library ............................................................................................... 60

RJSWRKSPLF: RJS Work with Spooled Files....................................................................... 60Description................................................................................................................ 60Command Parameters ............................................................................................... 60User........................................................................................................................... 60Output queue ............................................................................................................. 60Form type .................................................................................................................. 60User data ................................................................................................................... 61

Chapter 6 Problem Handling 63Common Errors ....................................................................................................................... 63Other Errors............................................................................................................................. 63

AS/400 Report Splitter Version 3.00 Users Guide Overview •••• 1

Overview

IntroductionThe AS/400 Report Splitter is a Native AS/400 Report Distribution application designed to distributeAS/400 reports to local or remote AS/400 users without the necessity of printing.

Utilizing the AS/400 Report Splitter, an entire report or selected portions of a report may be distributed toanother user.

The AS/400 Report Splitter allows a user to:

• Deliver an entire report.

• Split and deliver a selected page range.

• Scan a report for selected distribution criteria and extract selected pages.

• Split a report and create a new spool file each time the selected criteria changes.

• Scan the header of a report for a selected string value and deliver the entire report.

To facilitate the splitting of selected portions of a report, a level break or comparison data range must becoded in the report. This string can be up to 30 characters in length. The Report Splitter will scan the reportfor the selected comparison data range when the report is processed.

A report that has been split by the Report Splitter can be automatically distributed to up to ten local outputqueues and ten remote users when selection criteria is entered at run time. When using the ReportDistribution Table, up to 99999 different selection criteria and destination users can be specified for areport.

The AS/400 Report Splitter's command driven interface makes it easy to integrate the AS/400 ReportSplitter into existing applications with minimum effort. The Report Splitter also has an easy to use "WorkWith" style spool selection screen to provide users with easy interactive access to the AS/400 ReportSplitter functionality.

The AS/400 Report Splitter also includes an output queue monitor that can monitor an output queue andautomatically intercept and distribute selected reports. The output queue monitor program is the best way toautomate the entire AS/400 report distribution process with the report splitter.

For a more complete electronic report delivery system, the AS/400 Report Splitter can be integrated withany of the RJS electronic report distribution products. When integrated with the other RJS AS/400 reportdistribution products, reports can be automatically delivered via:

2 •••• Overview AS/400 Report Splitter Version 3.00 Users Guide

• Email (WinSpool/400 Email Report Server or Native Email Report Server/400 product)

• LAN (WinSpool/400 Batch Report Server or Native Batch Report Server/400)

• CD-ROM (WinSpool/400 Batch Report Server or Lotus Notes Report Server)

• Internet/Intranet (WinSpool/400 Web Report Server)

• Lotus Notes/Domino (WinSpool/400 Lotus Notes Report Server or Domino Report Server/400)

Licensing InformationAS/400 Report Splitter is licensed on a per AS/400 basis.

The license allows reports to be processed on one licensed AS/400 system.

Technical SupportFor AS/400 Report Splitter technical support, please review the following information before contactingRJS Software Systems.

For Technical Support with AS/400 Report SplitterBecause of the complexity of dealing with the various AS/400 connectivity environments, please gather andorganize as much information as possible on the problem prior to contacting RJS Software Systems forsupport.

If you have a question about an AS/400 Report Splitter operation, first browse through the user’s guide totry to find your answer prior to calling RJS Software Systems.

Contact Information

Telephone support is available from 8 AM to 5 PM Central time on normal business days at:

(612) 822-0412 Voice(612) 822-1364 Fax

Support is also available via Internet Email at:

[email protected] (Internet)http://www.rjssoft.com (WWW)

AS/400 Report Splitter Version 3.00 Users Guide Chapter 1: Installation •••• 3

Chapter 1: Installation

Introduction• This section covers the installation of AS/400 Report Splitter on the AS/400 system that will be running the software.

AS/400 Prerequisites for AS/400 Report SplitterA RISC AS/400 system running V4R2-V4R5 is required to run the software.

A non-RISC version of the software for V3R2 can be shipped upon request.

AS/400 InstallationThis section includes instructions for restoring the AS/400 Report Splitter AS/400 library.

AS/400 Installation Using RSTLIB commandInsert the RJS CD into the AS/400 CD Drive and sign on to the AS/400 with a user ID that has securityofficer authority.

Run the following AS/400 command to restore the AS/400 Report Splitter library:RSTLIB SAVLIB(RPTSPLIT30) DEV(OPT01) OPTFILE(‘/RPTSPLIT.30’)

AS/400 Installation Using FTPThis method of installation is described in the RJS Product Catalog and also on the RJS Software Systemsinstallation screen on the RJS CD.

AS/400 User Authorization Code EntrySign on to the AS/400 with a user ID that has security officer authority.

Entering AS/400 Report Splitter Access CodeAdd the RPTSPLIT30 library to the user library list by typing: ADDLIBLE RPTSPLIT30 and pressing

Enter

4 •••• Chapter 1: Installation AS/400 Report Splitter Version 3.00 Users Guide

From the AS/400 command line type: RPTSECURE and press the F4 key to prompt the command. Typethe access code provided by RJS Software Systems and press Enter to save the access code.

If you have questions or problems with entering the access codes, contact RJS Software Systems forassistance.

Entering Operating System Specific SettingsAdd the RPTSPLIT30 library to the user library list by typing: ADDLIBLE RPTSPLIT30 and pressingEnter

From the AS/400 command line type: RPTOS and press the F4 key to prompt the command. Type theOS/400 version specific settings. Type 82 if using OS/400 V4R2 or enter 88 if using OS/400 V4R3 ornewer. Press Enter to save the access code.

If you have questions or problems with entering the operating system setting, contact RJS Software Systemsfor assistance.

Deinstallation of AS/400 Report SplitterThe following sections describe how to remove the AS/400 Report Splitter software from an AS/400system.

Removing AS/400 Report Splitter from an AS/400To remove AS/400 Report Splitter from an AS/400, perform the following individual steps.

1. Make sure the RPTSPLIT30 library is not being used.

2. Delete the RPTSPLIT30 library from the AS/400 by entering a DLTLIB RPTSPLIT30 command froman AS/400 terminal.

AS/400 Report Splitter Version 3.00 Users Guide Chapter 2: Getting Started •••• 5

Chapter 2: Getting Started

IntroductionThe purpose of this chapter is to describe how to quickly get started using the AS/400 Report Splittersoftware to electronically deliver AS/400 reports.

Installing the AS/400 Report Splitter SoftwareIf you haven’t installed the software yet, go back to the installation section and install the software beforecontinuing. If you’re just reading ahead to find out what to do, then please continue.

Overview of Report Splitting ProcessThe AS/400 Report Splitter is a Native AS/400 Report Distribution application designed to distributeAS/400 reports to local or remote AS/400 users without the necessity of printing.

Utilizing the AS/400 Report Splitter, an entire report or selected portions of a report may be distributed toanother user.

The AS/400 Report Splitter allows a user to:

• Deliver an entire report.

• Split and deliver a selected page range.

• Scan a report for selected distribution criteria and extract selected pages.

• Split a report and create a new spool file each time the selected criteria changes.

• Scan the header of a report for a selected string value and deliver the entire report.

To facilitate the splitting of selected portions of a report, a level break or comparison data range must becoded in the report. This string can be up to 30 characters in length. The Report Splitter will scan the reportfor the selected comparison data range when the report is processed.

Note: When scanning for selected criteria, the criteria must be found on each page that will be split within areport.

A report that has been split by the Report Splitter can be automatically distributed to up to ten local outputqueues and ten remote users when selection criteria is entered at run time. When using the ReportDistribution Table, up to 99999 different selection criteria and destination users can be specified for areport.

6 •••• Chapter 2: Getting Started AS/400 Report Splitter Version 3.00 Users Guide

The AS/400 Report Splitter's command driven interface makes it easy to integrate the AS/400 ReportSplitter into existing applications with minimum effort. The Report Splitter also has an easy to use "WorkWith" style spool selection screen to provide users with easy interactive access to the AS/400 ReportSplitter functionality.

The AS/400 Report Splitter also includes an output queue monitor that can monitor an output queue andautomatically intercept and distribute selected reports. The output queue monitor program is the best way toautomate the entire AS/400 report distribution process with the report splitter.

For a more complete electronic report delivery system, the AS/400 Report Splitter can be integrated withany of the RJS electronic report distribution products. When integrated with the other RJS AS/400 reportdistribution products, reports can be automatically delivered via:

• Email (WinSpool/400 Email Report Server or Native Email Report Server/400 product)

• LAN (WinSpool/400 Batch Report Server or Native Batch Report Server/400)

• CD-ROM (WinSpool/400 Batch Report Server or Lotus Notes Report Server)

• Internet/Intranet (WinSpool/400 Web Report Server)

• Lotus Notes/Domino (WinSpool/400 Lotus Notes Report Server or Domino Report Server/400)

How to Run the Report Splitter Process The report splitting process can be run using one of the following methods:

Interactively using Work with Report Splitter OptionUsing the Work with Report Splitter (WRKSPLIT) option, a report can be selected and splitinteractively. A report is selected by viewing a list of reports from a selected AS/400 output queue and thenselecting a report to split from the list.

Programmatically using the Report Splitter CL CommandThe Report Splitter (RPTSPLIT) CL command can be run from the AS/400 command line. The ReportSplitter command can also be embedded into any CL program to allow report splitting to be integrated withany custom AS/400 report creation application.

Automatically via the Output Queue MonitorThe Output Queue Monitor (RPTMON) command can be run during nightly processing to automaticallyprocess all reports from a selected output queue. The output queue monitor can also run in batch all daylong to process and split reports as they are generated. The output queue monitor can also be run from theAS/400 job scheduler.

Available Report Splitting MethodsReports can be split using one of the following methods:

Distribute a Copy of the Entire ReportAn entire report can be copied and distributed to one or more AS/400 print queues using the *NOSPLIToption. This is a great way to electronically distribute multiple copies of a single AS/400 report to multipleusers.


Distribute a Copy of the Selected Page RangeA selected number of report pages can be copied and distributed to one or more AS/400 print queues usingthe *PAGERANGE option. This is a great way to distribute selected sections of a report based on a pagenumber range selection. One use for the page range option is to allow a single report to be printed onmultiple printers. An example of using this option would be printing a 1000 page report on 2 printers. Pages1-500 could be printed on one printer and pages 501-1000 could be printed on another printer.

Decollate a Single Report into Multiple ReportsA single report can be automatically decollated into multiple reports by using the *ALL option. This is agreat way to break a report into sections every time a selected value within a report changes. Manycompanies create sales reports, commission reports, etc. that are created as a single report, but they want tobreak up the report into sections each time the sales rep, sales manager, customer etc. changes. The *ALLoption works well in these scenarios.


Scan Report for a String and Distribute a Copy of the Entire ReportSelected columns within a report header can be scanned for a criteria string using the *SCANHDR option.If the selected string is found within the first few 100 lines of the report, the entire report can be distributedto the selected report queue.

Extract Selected Pages based on Criteria within ReportA report can be scanned for a selected criteria value. Each time the criteria are found within the report, theselected pages are reprinted in a new report. This is a great way to extract a selected portion of a report anddistribute the new report electronically to another output queue, via email etc.


Distribute only the Last Page of a ReportThe *LASTPAGE option can be used to distribute only the last page of a selected report. This option isuseful when distributing report information to executives who only need to see report total information.

Distribute a report using Report Distribution CriteriaThe *TABLE option can be used to distribute a report based on the Report Distribution Criteria table. Upto 99,999 entries can be entered for a particular report. The report distribution criteria are driven by spoolfile name. You will need to make sure your reports are created with unique Spool File Names or User Datanames to make sure the report distribution settings will work correctly with a selected report.

Note: See section below on creating reports with unique spool file names or user data.

Assigning Email Addresses to a ReportIf you will be automatically emailing AS/400 reports using the WinSpool/400 Email Report Server or theEmail Report Server/400 product, you can embed an email address within a report using one of thefollowing methods:

• Code the MAILTO: keyword at the beginning of the report or in each report section that will be splitwith the report splitter.


• When setting up a Report Distribution Criteria entry, a report cover page can be created and theMAILTO: keyword can be printed as part of the cover page text.

The Email Report Server will extract the email address from a MAILTO: line and will email the report tothe selected email recipient.

If multiple email addresses are coded in the report, the last email address should be delimited with a tilde ~.

Example email address line with 1 email address: MAILTO: [email protected]

Example multiple email address line: MAILTO: [email protected];[email protected]~

Flow for Interactively Splitting a Report1. Sign on to the AS/400 and add the Report Splitter library to your library list using the ADDLIBLE

RPTSPLIT30 command.2. Type GO RPTSPLIT to go the report splitter main menu.3. Take Option 3, Work with Report Splitter to display a list of reports available in a selected output

queue.4. Place an Option 13 next to a report you would like to split and press Enter.5. Key in the selected criteria and press Enter to split the report interactively.

Flow for Automatic Report Processing 1. Reports are generated on an AS/400 and placed into selected output queue(s) so the AS/400 Report

Splitter process can retrieve and split the reports.

2. The Output Queue Monitor (RPTMON) job is submitted by a user job or the AS/400 job schedulerwhen reports are ready to be captured and distributed from a selected output queue. The Output QueueMonitor process can be run once or can be set up to automatically monitor for new reports on a timedinterval.

Most companies run the output queue monitor process once at the end of their nightly report processing soall reports get captured and distributed in one pass at the same time. If multiple source output queues will beprocessed, the output queue monitor must be submitted once for each source output queue.

3. When an output queue gets processed, the Report Distribution Table is checked for the correct splittingcriteria. If criteria are found for a selected report, it is processed and split using the criteria.

4. After each report is processed it can be automatically marked as sent, deleted or moved to another outputqueue.

Flow for Embedding the Report Splitter Command in a Program1. Create a CL program that generates an AS/400 report from a query or RPG program.

2. After the report program runs, use the RPTNUM command to retrieve the spool file attributes.

3. Run the Report Splitter (RPTSPLIT) command to split the report using the spool file informationretrieved by the RPTNUM command.

A sample CL program is included in the “Sample CL Program Code” section of this chapter.


Identifying Splitting Criteria within a ReportBefore splitting a report that contains selected criteria, you need a quick lesson on how to identify thecorrect report data line and columns when splitting a report. Find a report you want to split by using theAS/400 WRKOUTQ or WRKSPLF command and then open the report for viewing using Option 5.

Figure 1 Sample Report

Since the AS/400 Display Spool File option doesn’t show blank lines in the report, follow the steps listedbelow to determine which data line and columns to use when splitting a report.

1. Display the spool file.2. Place a +1 in the Control field and press Enter until the data line to scan on is displayed at the top of

the screen directly under the white ruler line.3. Look in the upper right hand corner of the screen to determine the actual line number to scan. In this

example, we will be scanning line 10 on each page. We will also scan columns 1-7 where the customernumber 938,472 is located.

After determining the page line and columns to scan, you are ready to split a report using selected criteria.

Note: If you don’t correctly determine the actual report data line to scan within a report, your splittingresults may not come out as expected. Always make sure to identify the correct data line and column rangebefore attempting to split a report.

Sample AS/400 ReportIn this section we will describe the sample report included when the AS/400 Report Splitter software isshipped. We will also describe how to generate the report in an output queue so you can use it to test theAS/400 Report Splitter software.


Generating the Sample ReportSign on to the AS/400 system and add the RPTSPLIT30 library to your library list by using the followingAS/400 command: ADDLIBLE RPTSPLIT30.

Next type: GO RPTSPLIT and press enter. This will take you to the AS/400 Report Splitter main menu.

Take Option 9. (Generate Report Splitter Sample AS/400 Report) and select an output queue where youwould like the sample report to be generated. Press Enter to generate the sample report.

Sample Report CharacteristicsThe report is a sample “Outstanding Invoices” report that is broken up by Sales Rep. The report data isfictional. This report is to be used for learning purposes only.

Figure 2 Sample Report

The report is broken down as follows:

Sales Rep Data Line Location: Line 3 of every pageSales Rep Data Columns: Starting column: 8 , Ending column: 10.

Here is the sample report page sort breakdown by sales rep:

Page 1-2: Sales Rep: 100Page 3: Sales Rep: 200Page 4-6: Sales Rep: 300Page 7: Sales Rep: 400Page 8-9: Sales Rep: 100Page 10: Sales Rep: 200Page 11-13: Sales Rep: 300Page 14: Sales Rep: 400


Note: the sample report isn’t sorted entirely by sales rep. We did this because we will be teaching you howto split a report using the Multiples setting to make sure the splitter picks up all instances of the comparisoncriteria regardless of where they are within the report.

Manually Splitting your First ReportLet's begin by manually splitting an entire report to make sure the Report Splitter works correctly.

Sign on to the AS/400 system and add the RPTSPLIT30 library to your library list by using the followingAS/400 command: ADDLIBLE RPTSPLIT30.

Next type: GO RPTSPLIT and press enter. This will take you to the AS/400 Report Splitter main menu.

Take Option 9. (Generate Report Splitter Sample AS/400 Report) and select an output queue where youwould like the sample report to be generated. Press Enter to generate the sample report.

Take Option 3. (Work with Report Splitter) and select the output queue that contains the sample reportyou just created. Once the output queue name has been entered, press Enter and the Work with ReportSplitter selection screen will be displayed.

Figure 3 Work with Report Splitter Report Selection

Place a 13 next to the sample report you want to split. Press Enter and the Report Splitter ParameterSelection prompt will be displayed.


Figure 4 Report Splitter Parameter Selection Screen for *NOSPLIT

Enter the following parameters to split an entire report. The parameters will be explained in more detail inthe reference section:

Beginning comparison criteria: *NOSPLIT

Destination output queue/library: Enter a destination output queue where the selected report will beduplicated.

After typing the report information, press Enter to split the report. Once the report splitter completes, thenew report(s) should have been created in the selected destination output queue.

Manually Splitting a report by Page RangeThis option will split a report based on a specific selected page range.

Go to the Work with Report Splitter screen and select the sample report for splitting. The Report SplitterParameter Selection screen will be displayed as shown below.


Figure 5 Report Splitter Parameter Selection Screen for *PAGERANGE

Enter the following parameters to split the report by page range. The parameters will be explained in moredetail in the reference section:

Beginning comparison criteria: *PAGERANGE

Page range: 1 - 5



Manually Decollating a Report each time Criteria ChangesThis option will split a single report into multiple reports every time a selected value within the reportchanges. The reports are split into the same output queue and the user data field for the reports will be setwith the criteria for each report section. This allows the resulting reports to be easily distributed with theRJS Email Report Server, Batch Report Server, Domino Report Server, etc. The Email Report Server andother products can utilize the user data values to determine where to distribute the resulting reports.



Figure 6 Report Splitter Parameter Selection Screen for *ALL

Enter the following parameters to split the report into a new report each time the selected criteria changes.The parameters will be explained in more detail in the reference section:

Beginning comparison criteria: *ALL

Compare data line: 3

Compare data column range: 8 -10



Manually Distributing an Entire Report if Selected Criteria FoundThis option will scan the selected column range for a specified search string within the first 100 lines of thereport. If the selected string is found, the entire report will be duplicated and sent to the selected outputqueue. The search strings are CASE sensitive.



Figure 7 Report Splitter Parameter Selection Screen for *SCANHDR

Enter the following parameters to search and distribute the entire report if the selected search string is foundwithin the first 100 report lines. The parameters will be explained in more detail in the reference section:

Beginning comparison criteria: *SCANHDR

Ending comparison criteria: Rep: 100


Compare data column range: 8 -10



Manually Distributing a Selected Section of a ReportThis option will scan the selected page line and columns for a selected search string. All pages containingthe criteria will be split into a new report and delivered to the selected output queue(s).




Figure 8 Report Splitter Parameter Selection Screen for Selected Criteria

Enter the following parameters to search and distribute the selection section of a report. The parameters willbe explained in more detail in the reference section:

Beginning comparison criteria: 100 (This will search for Rep 100)

Ending comparison criteria: 100 or *SAME (This will search for Rep 100)


Compare data column range: 8 –10

Mult. Compare Occurrences:

*NO – The report will be searched until Rep 100 is found. When the criteria changes to 200 after Rep 100has been found, the splitter processing will stop searching the report for additional occurrences of Rep 100.

Based on our sample report, Pages 1-2 will get split out in this scenario. When Rep 200 is found, thesplitting stops. This scenario assumes the report would normally be sorted correctly by Rep. The scenario isvery efficient because the entire report doesn’t need to be searched since the report is assumed to be sortedby Rep. Our sample report is not entirely sorted by Rep for illustration purposes.

*YES – The entire report will be searched for all occurrences of Rep 100. The entire report will beprocessed in this scenario.

Based on our sample report, Pages 1-2 and 8-9 will get split out into a single report. This scenario doesn’tcare how the report is sorted because the entire report is searched for occurrences of Rep 100. The scenariois not very efficient because the entire report has to be searched. When dealing with very large reports, thesplitting could take longer than desirable. You will need to make sure to test all reports before putting newsplitting criteria with this setting into production.




Manually Distributing the Last Page of a ReportThis option will distribute only the last page of the selected report. The last report page will be split into anew report and delivered to the selected output queue(s). This is a great way to deliver total pages to amanager or other employee/customer who doesn’t need to see an entire report.


Figure 9 Report Splitter Parameter Selection Screen for *LASTPAGE

Enter the following parameters to search and distribute the selection section of a report. The parameters willbe explained in more detail in the reference section:

Beginning comparison criteria: *LASTPAGE



Setting up Report Distribution Criteria EntriesIn order to automate the distribution of reports using the output queue monitor and selected reportdistribution criteria, the Report Splitter Distribution Entry program is used to enter criteria for each report.

Let's set up some criteria for a sample report.


Sign on to the AS/400 system and add the RPTSPLIT30 library to your library list by using the followingAS/400 command: ADDLIBLE RPTSPLIT30.

Next type: GO RPTSPLIT and press enter. This will take you to the AS/400 Report Splitter Main Menu.

Take Option 20. (Report Splitter Distribution Entry) and the Report Splitter Distribution Entryselection screen will be displayed.

Figure 10 Report Splitter Distribution Entry

Type the spool file name for the report you want to work with and press the F6 key to add new entries orF10 to update or delete entries from the Report Distribution Table. In our example we will use spool fileQSYSPRT.

Note: If you want to create different groups of settings for Daily or Monthly groups, you can also enter auser defined Spool File Group name. This is not required and is only necessary if you will be breakingyour settings into Daily, Weekly or Monthly groupings or you have other groupings you would like to use.

After pressing F6, the following screen will appear.


Figure 11 Report Splitter Distribution Entry Detail

Type a D in the Opt field and press Enter to automatically fill in the report distribution defaults for theselected report.

Enter 100 for the sequence number. The sequence number is an arbitrary user defined number assigned toeach entry. Each criteria entry must have a unique sequence number. We usually recommend incrementingthe sequence number by 100 for each entry to allow room to insert entries between existing entries at a laterdate.

Change the destination output queue to something other than QPRINT.

If you would like to enter additional distribution criteria records for spool file QSYSPRT, simply press thePage Down key to view a blank record. Up to 99,999 distribution criteria entries can be entered for eachreport.

Note: The following values can also be used in the Opt field to clear, copy and paste entry data whencreating new criteria entries. These options can save a lot of keying time.• D - Entering this value and pressing the Enter key, sets the default field entry values for the current

report distribution table record. This can be useful when adding new entries.• E - Entering this value and pressing the Enter key, clears all entry values for the current report

distribution table record. This can be useful when deleting a single entry.• C - Entering this value and pressing the Enter key, copies all the field entry values for the current

report distribution table record. This can be useful when copying entries.• P - Entering this value and pressing the Enter key, sets all the field entry values for the current report

distribution table record to match the most recently copied record. This can be useful when copyingentries.

After entering all appropriate criteria for the selected report, press Enter to update the Report DistributionTable entries. DO NOT press Enter until you’re ready to update all records.

Note: Usually you will not use the Enter key until all data entry is complete. You will navigate the existingentries using the Page Up/Down keys.


See the Report Distribution Entry chapter for additional detail on creating Report Distribution Criteriaentries.

Manually Splitting a Report using Report Distribution Criteria TableThis option will distribute a report based on pre-defined report distribution table settings. Up to 99,999different recipients can be specified for a single report in the report distribution table. When this option isselected, all criteria, including the destination output queue(s) are selected from the report distribution table.When automating the AS/400 Report Splitter processing, you will most likely be using the reportdistribution criteria Table to hold all report distribution settings.


Figure 12 Report Splitter Parameter Selection Screen for *TABLE

Enter the following parameters to use the pre-defined report distribution table settings to distribute a report.The parameters will be explained in more detail in the reference section:

Beginning comparison criteria: *TABLE


Note: Remember that when creating Report Distribution Criteria entries, the information is based on spoolfile name.

Manually Distributing a report and Embedding an Email AddressThis option will distribute an entire report and will create a cover page with an email address on it. This is anice way to split and email a report to someone via the WinSpool/400 Email Report Server or Email ReportServer/400 software. The WinSpool/400 Email Report Server and Email Report Server/400 products alsoinclude additional methods for manually mailing an entire report.



Figure 13 Report Splitter Parameter Selection Screen for Embedding Email Address

Enter the parameters as shown to send out the entire report to the selected output queue. Make sure theoutput queue is a queue that will be monitored by the WinSpool/400 Email Report Server or Email ReportServer/400 software.

Press F11 to display the Cover Page Screen. Enter the cover page info as follows. You can use your ownemail addresses instead of the sample ones we used. All 5 lines can have a MAILTO: keyword if necessary.

Figure 14 Cover Page Creation


After typing the report information, press Enter to split the report. Once the report splitter completes, thenew report(s) should have been created in the selected destination output queue. They are ready to beprocessed by the Email Report Server software.

Automatically Splitting Reports using Output Queue MonitorWhen you’re ready to start splitting reports automatically for the first time using the Output Queue Monitor,do the following:

Create all the reports you want to split into a selected output queue. For this example, we will assume thatall of our nightly reports are placed in an output queue called: REPORTS in library QGPL.

Run the following AS/400 command interactively or submit it to batch to run the Output Queue Monitorone time. Once you get comfortable with the concept of using the output queue monitor to process reports,you can set the command up in an AS/400 job scheduler or as part of your nightly processing.

RPTMON FILE(*TABLE) SPLFOPT(*MARK) OUTQ(QGPL/REPORTS) RUNMODE(*INTER)DELAY(*ONCE)

When the command completes, all reports from the REPORTS output queue should be processed andmarked as *SENT in the user data field. The SPLFOPT parameter can also be used to move the reports toanother output queue after being processed or delete them.

Embedding Report Splitter Command in User Written ProgramBy including the AS/400 Report Splitter command within an existing CL program, AS/400 reports can beautomatically distributed to users on the AS/400 as soon as they’re created on the system. This preventsspecial intervention to manually distribute a report to an AS/400 user.

Running the Report Splitter in a CL job streamIf a job stream is to be set up where the Report Splitter is run right after a new report spool file has beencreated, you can include a call to the Report Splitter command right after the report creation program. Oncethe report program has completed, the report will be automatically distributed to the selected destinations.Following is an example of including the Report Splitter command in a CL report creation job stream anddistributing the report using the Report Distribution Table criteria.

Note: Always use the RPTNUM command to retrieve the original spool file information prior to processingthe report with the Report Splitter command, otherwise the AS/400 Report Splitter may select the incorrectversion of the spool file when splitting a report multiple times within the same AS/400 job.

Note: You must also make sure to define all the CL return variables for the RPTNUM command or youmay get a MCHxxxx error when running the RPTNUM command.

Note: You must also make sure to remove all printer overrides with the DLTOVR command before callingthe RPTMON or RPTSPLIT commands, otherwise reports may not get routed correctly.

CL Sample Program CodePGM

/****************************************************************/


/* DEFINE SPOOL FILE INFORMATION VARIABLES *//****************************************************************/DCL VAR(&SPLFNAME) TYPE(*CHAR) LEN(10)DCL VAR(&JOBNAME) TYPE(*CHAR) LEN(10)DCL VAR(&JOBUSER) TYPE(*CHAR) LEN(10)DCL VAR(&JOBNBR) TYPE(*CHAR) LEN(6)DCL VAR(&SPLNBR) TYPE(*CHAR) LEN(4)

/****************************************************************//* SET UP PRINTER FILE OVERRIDE TO SET USER DATA *//****************************************************************/OVRPRTF FILE(RPT100P) USRDTA(SALES)

/****************************************************************//* PRINT AS/400 REPORT *//****************************************************************/CALL PGM(RPT001)

/****************************************************************//* REMOVE PRINTER OVERRIDE RIGHT AFTER REPORT IS PRINTED *//****************************************************************/DLTOVR FILE(RPT001P)

/****************************************************************//* RETRIEVE ORIGINAL SPOOL INFORMATION FROM REPORT JUST CREATED*//* NOTE: MAKE SURE TO DEFINE ALL RETURN PARAMETERS *//****************************************************************/RPTNUM SPLF(RPT001P) JOB(*) SPLNBR(*LAST) +

RTNSPLF(&SPLFNAME) RTNJOBNAME(&JOBNAME) +RTNJOBUSER(&JOBUSER) RTNJOBNUM(&JOBNBR) +RTNSPLNUM(&SPLNBR)

/****************************************************************//* PROCESS ORIGINAL SPOOL FILE WITH THE AS/400 REPORT SPLITTER *//* USING THE REPORT DISTRIBUTION TABLE *//****************************************************************/RPTSPLIT FILE(&SPLFNAME) +

JOB(&JOBNBR/&JOBUSER/&JOBNAME) +SPLNBR(&SPLNBR) BEGCMP(*TABLE)

/****************************************************************//* DELETE ORIGINAL AS/400 SPOOL FILE AFTER PROCESSING *//****************************************************************/DLTSPLF FILE(&SPLFNAME) +

JOB(&JOBNBR/&JOBUSER/&JOBNAME) +SPLNBR(&SPLNBR)

ENDPGM

Creating AS/400 Reports with Unique Spool File NamesIf you happen to run AS/400 queries or have a lot of reports that get created with QPQUPRFIL, QPRINT orQSYSPRT as the spool file name, the following CL programming technique can be used to ensure yourreports get created with a unique spool file name. Creating unique spool file names will insure that thereport splitter can process reports correctly.

PGM

/****************************************************************/


/* CREATE PRINTER OVERRIDE TO CHANGE QUERY SPOOL FILE NAME *//****************************************************************/OVRPRTF FILE(QPQUPRFIL) SPLFNAME(SALES01)

/****************************************************************//* PRINT AS/400 QUERY REPORT *//****************************************************************/RUNQRY QRY(QGPL/SALES01)

/****************************************************************//* REMOVE PRINTER OVERRIDE *//****************************************************************/DLTOVR FILE(QPQUPRFIL)

ENDPGM

The query defined above will create a spool file named SALES01 when it gets run.

Merging Multiple Reports into a Single Spool FileIf you would like to merge multiple spool files into a single report, use the Report Merge (RPTMRG)command. The Report Merge command is described in the AS/400 Commands chapter.

What’s Next ?You should now have the basics down for manually and automatically splitting AS/400 reports and stagingthem to be emailed or archived via other RJS report distribution products. The next few chapters are areference for the Report Splitter menu options and each of the AS/400 commands and available parameters.

Your input is also appreciated to help us keep improving our user guides. If there’s something you wouldlike to see in future versions of the user manuals, send your comments to: [email protected] or give us acall.

AS/400 Report Splitter Version 3.00 Users Guide Chapter 3: Available Menus •••• 25

Chapter 3: Available Menus

IntroductionThis chapter gives an overview of the AS/400 Report Splitter Main Menu.

Figure 8 AS/400 Report Splitter Main Menu

Getting to the Main MenuSign on to the AS/400 system and add the RPTSPLIT30 library to your library list using the followingAS/400 command: ADDLIBLE RPTSPLIT30.

Next type: GO RPTSPLIT and press enter. This will take you to the AS/400 Report Splitter Main Menu.

26 •••• Chapter 3: Available Menus AS/400 Report Splitter Version 3.00 Users Guide

Available Options

Option 1 – Enter AS/400 Report Splitter License CodeThis menu option is used to enter the AS/400 access code for the AS/400 Report Splitter software. Anaccess code will be provided to you by RJS Software Systems Inc.

Option 2 – Enter OS/400 SettingsThis menu option is used to enter OS/400 version specific settings.Enter 82 if using OS/400 V4R2 or enter 88 if using OS/400 V4R3 or newer.

Option 3 – Select and Split Reports InteractivelyThis menu option is used to interactively select and split a report from a specific output queue. This is thebest way to split AS/400 reports on an ad-hoc basis.

Option 4 – Run Report Splitter Output Queue Monitor - RPTMONThis menu option is used to submit the output queue monitor to batch or run it interactively. The outputqueue monitor is used to automatically process all the reports from a selected output queue using the ReportDistribution Criteria settings.

Option 5 – Submit Report Splitter Output Queue Monitor to BatchThis menu option is used to submit the output queue monitor to batch. The output queue monitor is used toautomatically process all the reports from a selected output queue using the Report Distribution Criteriasettings.

Option 6 – Report Splitter Command - RPTSPLITThe Report Splitter command is a CL command used to split AS/400 reports from a user written program.The Report Splitter command can be embedded into a custom CL, RPG or COBOL program to add reportsplitting to user applications.

Option 7 –Report Splitter Spool Merge Command - RPTMRGThe Report Merge command is a CL command used to merge multiple reports from a selected output queueinto a single spool file. The Report Merge command can be run standalone or embedded into a custom CL,RPG or COBOL program to add report merging to user applications.

Option 8 – Report Splitter Reprint Spool File Utility - RPTREPRINTThe Report Reprint command is a CL utility command used to reprint any AS/400 report manually usingthe selected printer attributes. This command is a utility command provided for the purpose of doing asimple report reprint.

Option 9 –Generate Report Splitter Sample AS/400 Report - RPTTESTThis menu option is used to create the sample spool file report included with the AS/400 Report Splitter.

Option 20 – Report Splitter Distribution EntryThis menu option is used to enter AS/400 Report Splitter Distribution settings.

AS/400 Report Splitter Version 3.00 Users Guide Chapter 3: Available Menus •••• 27

Option 21 – Report Splitter Distribution Table ListingThis menu option is used to print selected AS/400 Report Splitter Distribution settings. This is a nice way tocreate a hard copy of all AS/400 Report Splitter distribution settings.

Option 22 – Copy Report Distribution EntriesThis menu option is used to copy selected report distribution settings. This is an easy way to duplicatereport settings for a new report name.

AS/400 Report Splitter Version 3.00 Users Guide Chapter 4: Entering Report Splitter Distribution Criteria •••• 29

Chapter 4: Entering ReportSplitter Distribution Criteria

IntroductionThis chapter gives an overview of entering Report Distribution Criteria for selected reports. The ReportDistribution Criteria settings are used to automate report distribution processing.

The Report Distribution Table stores frequently used Report Splitter selection criteria. Once an entry hasbeen made in the distribution table, it can be reused anytime the Report Splitter command is run with*TABLE entered for the beginning comparison data. The table can hold up to 99,999 table entries for eachspool file name.

Report Distribution Settings are based on spool file name and an optional spool file group name.

Figure 15 Report Splitter Distribution Entry

30 •••• Chapter 4: Entering Report Splitter Distribution Criteria AS/400 Report Splitter Version 3.00 Users Guide

Getting to the Report Splitter Distribution EntrySign on to the AS/400 system and add the RPTSPLIT30 library to your library list using the followingAS/400 command: ADDLIBLE RPTSPLIT30.

Next type: GO RPTSPLIT and press enter. This will take you to the AS/400 Report Splitter Report Mainmenu.

Select option 20 to start the program.

Fields presented on the Report Distribution Main Selection Screen

Spool file nameEnter the AS/400 spool file name for which you will be entering criteria.

Spool file groupThe spool file distribution group is a nice way to separate settings that will be used on a daily basis ormonthly basis, etc. Example: You could create a group named DAILY for daily reports or MONTHLY formonth-end reports. Each group could have different report recipients specified.

Note: If you’re not sure how this setting will benefit your company, simply leave the spool file group fieldblank.

Figure 16 Report Distribution Criteria Detail Entry

Fields presented on the Report Distribution Detail Entry Screen

OptionThe option field is used to set default field entry values for the report distribution table. This field is alsoused to copy and paste field values into new records. The values allowed for this field are:


• D - Entering this value and pressing the Enter key, sets the default field entry values for the currentreport distribution table record. This can be useful when adding new entries.

• E - Entering this value and pressing the Enter key, clears all entry values for the current reportdistribution table record. This can be useful when deleting a single entry.

• C - Entering this value and pressing the Enter key, copies all the field entry values for the currentreport distribution table record. This can be useful when copying entries.

• P - Entering this value and pressing the Enter key, sets all the field entry values for the current reportdistribution table record to match the most recently copied record. This can be useful when copyingentries.

Spool file sequence numberThe sequence number that has been assigned to the selected spool file table entry. This is an arbitrary userdefined value. As a general rule, increment this value by 100 for each new entry to allow for future entriesto be inserted between existing entries.

Comparison data rangeThe compare data range fields contain the beginning and ending comparison data for the specified tableentry. Valid values for the beginning comparison data field are listed below:

If *NOSPLIT is selected, an entire report will be distributed.If *PAGERANGE is selected, the selected report page range will be distributed.If *ALL is selected, the entire report will be decollated based on the information entered for page line andpage columns. A new spool file will be created for each set of criteria.If *SCANHDR is selected, the report will be searched for a selected criteria value. If the criteria is found,the entire report will be distributed.If *LASTPAGE is selected, the last report page will be distributed.

Page lineThe page line field contains the report line that will be scanned for comparison data if a comparisonselection is made. If using *SCANHDR this value should always be 0. When scanning for specified criteria,this value can also be set to zero and all lines for each page will be scanned.

Page columnsThe page column range contains the beginning and ending column range that will be scanned if acomparison data selection is made. The only report line that is scanned is the selected page line.

Page rangeThe page range contains the beginning and ending pages to be reprinted if *PAGERANGE is selected onthe beginning compare data parameter.

Destination output queue/libraryThe destination output queue can be any existing output queue on the local system.

Destination user identifier/addressThe destination user identifier can be any valid user id that exists in the AS/400 system directory. Use theWRKDIR or WRKDIRE command to set up users in the AS/400 system directory. This value is only usedif running QSNADS on the AS/400 system.

Program that created spool file


Because it is possible for many different report programs to use the same spool file name (Example:QPRINT,QSYSPRT, etc), this parameter is used to differentiate the spool file entries by program name.

When a spool file is generated, it contains the program name that created it. The Report Splitter can filterand select spool file entries by the program name. The valid values for this field are *ANY, or the actualprogram name that created the spool file. This parameter must be entered, so *ANY should be used as adefault entry if a spool file is not shared by more than one program. If the program name doesn’t match thespool file program name or *ANY, the report distribution criteria entry will not by used to process thereport. The report splitter will move on to the next criteria entry.

Use the WRKOUTQ or WRKSPLF command Option 8 to view the program name that created a spool file.

JobIf the job name entry is specified, the spool file job name will be checked before the report distributioncriteria will be used for processing a particular report. This parameter can be a good way to filter spool fileselections for the selected report by job name. It’s essentially a report filter by AS/400 job name. If the jobname doesn’t match the spool file job name, the report distribution criteria entry will not by used to processthe report. The report splitter will move on to the next criteria entry.

UserIf the user entry is specified, the spool file user ID and user data will be checked before the reportdistribution criteria will be used for processing a particular report. This parameter can be a good way tofilter spool file selections for the selected report by user ID or user data. It’s essentially a report filter byAS/400 user ID or user data. If the user ID or user data value doesn’t match the spool file user ID or userdata, the report distribution criteria entry will not by used to process the report. The report splitter willmove on to the next criteria entry.

MultiplesThis parameter is used to scan for multiple compare occurrences. If this parameter is set to N, a spool filewill only be scanned for the first occurrence of the selected comparison data. If Y is selected, alloccurrences of the comparison data will be scanned for and the appropriate pages will be reprinted.

See the “Getting Started” chapter for a working example.

Banner TextIf Y is selected, a banner page will be printed at the beginning of the report when it is reprinted. If N isselected, no banner page will be printed. The banner page can be utilized to embed email addresses within areport using the MAILTO: keyword. It’s also a nice way to place a custom message at the beginning of areport.

Print BannerUp to 5 lines of text can be specified to print on the banner page if Y is selected on the Print Banner Pageparameter. This is where the MAILTO: keyword can be specified for emailing AS/400 reportsautomatically.

Example: MAILTO: [email protected]

Completion messageThis parameter is not currently being used by the AS/400 Report Splitter software.

Audit trailThis parameter is not currently being used by the AS/400 Report Splitter software.


ActivateThis parameter is used to activate or deactivate selected entries in the Report Distribution Table. If thisparameter is set to Y, the selected entry is active and will be used when the Distribution Table is used by theRPTSPLIT command. If N is selected, the selected entry will be ignored by the RPTSPLIT command whenthe Distribution Table is used.

DescriptionThis parameter can be used to enter a meaningful user description for the specified criteria entry. This is afield that can be utilized by the user when querying the Report Distribution Table file RSPL00.

New Form TypeThis parameter is used to assign the selected form type to the new report created when the selected report isprocessed.

New User DataThis parameter is used to assign the selected user data to the new report created when the selected report isprocessed.

New CopiesThis parameter is used to assign the selected number of print copies to the new report created when theselected report is processed.

New Save StatusThis parameter is used to assign a new save status to the new report created when the selected report isprocessed.

New Output PriorityThis parameter is used to assign a new output priority to the new report created when the selected report isprocessed.

New Align PageThis parameter is used to assign a new align page status to the new report created when the selected reportis processed.

New Spool File NameThis parameter is used to assign a new spool file name to the new report created when the selected report isprocessed.

New Hold StatusThis parameter is used to assign a new hold status to the new report created when the selected report isprocessed.

New TextThis parameter is used to assign a new print text value to the new report created when the selected report isprocessed. The print text is a 30-character line of text that can be printer across the bottom of each reportpage.

New Print TextThis parameter is used to determine whether the specified print text is printed on the new report createdwhen the selected report is processed.

New IBM File Separator


This parameter is used to assign a new IBM file separator value to the new report created when the selectedreport is processed. The IBM file separator is a banner page, which prints information about the job thatcreated a spool file.

Note: The Report Splitter banner page is more appropriate if you want to create a banner page. The ReportSplitter banner page lets you assign up to 5 lines of text to be printed on a report cover page.

New Beginning PageThis parameter is used to determine the new beginning page range assigned to the new report created whenthe selected report is processed.

Note: Under normal circumstances, the *PAGERANGE option should be used instead of this option whichassigns the new page range directly to a spool file. The only time this option should be used is if an entirereport is reprinted and you want to assign a page range directly to the spool file.

New Ending PageThis parameter is used to determine the new ending page range assigned to the new report created when theselected report is processed.

Note: Under normal circumstances, the *PAGERANGE option should be used instead of this option whichassigns the new page range directly to a spool file. The only time this option should be used is if an entirereport is reprinted and you want to assign a page range directly to the spool file.

Report Distribution Table Maintenance Modes

Addition ModeAfter entering the selected spool file name and spool file group name which will be maintained, press the F6key and the Report Distribution Detail Entry Screen will be shown if no records currently exist in theReport Distribution Table for the selected spool file name and spool file group. If an error message isshown which says “Record already exists”, you will need to use Change Mode to update existing entriesor to add or delete single entries in the Report Distribution Table.

Once the record maintenance screen is shown, key the new record information and use the page up/downkeys to navigate between records. After keying all the desired distribution table information, press Enter toadd all the new records or F12 to return to the main selection screen without any records being added.

Note: All records are added or updated at the same time.

Change ModeAfter entering the selected spool file name and spool file group name which will be maintained, press theF10 key and the Report Distribution Detail Entry Screen will be shown if records exist in the ReportDistribution Table for the selected spool file and spool file group. If an error message is shown which says“Record not found”, you will need to use Add Mode to add new table entries to the Report DistributionTable. After records have been added to the table for the selected spool file name and spool file group, youwill be able to use Change Mode.

Once the record maintenance screen is shown, key any record changes and use the page up/down keys tonavigate between records. After rolling past the last record on the change entry screen, blank records areshown for new additions to the spool file name and spool file group combination. If all the fields for anexisting record are blanked or erased using the (E)rase option, the current record will be deleted from thereport distribution table. After keying or erasing all the desired distribution table information, press Enter to


update existing records and add or delete selected records or F12 to return to the main selection screenwithout any records being updated.

Note: All records are added or updated at the same time.

Delete ModeAfter entering the selected spool file name and spool file group name which will be deleted, press the F23key and the Report Distribution Detail Entry Screen will be shown if records exist in the ReportDistribution Table for the selected spool file name and spool file group. If an error message is shown whichsays “Record not found”, there are no records to delete.

Once the record maintenance screen is shown, press Enter in order to Delete All Records which belong tothe currently selected spool file name and spool file group or F12 to return to the main selection screenwithout any records being deleted.

Note: All records are deleted at the same time. If you want to remove an individual record, use ChangeMode and the (E)rase value in the Opt field to delete a single entry record.

Inquiry ModeAfter entering the selected spool file name and spool file group name which will be displayed, press the F8key and the Report Distribution Detail Entry Screen will be shown if records exist in the ReportDistribution Table for the selected spool file name and spool file group. If an error message is shown whichsays “Record not found”, there are no records to display.

Once the record display screen is shown, press Enter or F12 to return to the main selection screen.

Sample Settings using the *NOSPLIT option

Figure 17 *NOSPLIT Criteria Sample

This example will distribute a copy of the entire report.

Type a D in the Opt field and press Enter to set the default values:


Make sure to key the following required parameters:

Sequence: Enter an arbitrary sequence number for each entry. A general recommendation is to incrementthe sequence by 100 for each entry in case additional entries need to be inserted between existing entries

Comparison data range: *NOSPLIT

Destination outq/library: Enter a destination output queue where the selected report will be duplicated.

Pgm: *ANY

Activate: Y

Note: All additional setting parameters are optional.

After typing the report settings press the Page Down key to key additional entries or press Enter to save allchanges made.

Sample Settings using the *PAGERANGE option

Figure 18 *PAGERANGE Criteria Sample

This example will distribute a copy of the selected report page range.




Comparison data range: *PAGERANGE

Page range: Enter the selected page range.



Pgm: *ANY

Activate: Y



Sample Settings using the *ALL option

Figure 19 *ALL Criteria Sample

This example will break the selected report into multiple sections. Each time the selected criteria changes anew spool file will be created and the criteria will be placed in the user data field.




Comparison data range: *ALL

Page line: Enter the selected page line.

Page columns: Enter the selected page column data.



Pgm: *ANY

Activate: Y



Sample Settings using the *SCANHDR option

Figure 20 *SCANHDR Criteria Sample

This example will search the first 100 lines of the sample report for Rep 100. The selected columns will besearched for the data. If Rep: 100 is found, the entire report will be distributed.




Comparison data range line 1: *SCANHDR

Comparison data range line 2: Rep: 100

Page line: 0.

Page columns: 8 - 15.


Pgm: *ANY


Activate: Y



Sample Settings Scanning for Selected Criteria

Figure 21 Scanning for Selected Criteria Sample

This example will search the entire sample report for Rep 100. All pages that contain Rep 100 will beextracted when the report is split.




Comparison data range: 100 for beginning and ending comparison data

Page line: 3

Page columns: 8-10.


Pgm: *ANY

Multiples: Y


Activate: Y



Sample Settings using the *LASTPAGE option

Figure 22 *LASTPAGE Criteria Sample

This example will distribute the last page of the selected report.




Comparison data range: *LASTPAGE


Pgm: *ANY

Activate: Y



AS/400 Report Splitter Version 3.00 Users Guide Chapter 5 – AS/400 Commands •••• 41

Chapter 5 – AS/400 Commands

IntroductionThis chapter gives an overview of the main AS/400 Report Splitter AS/400 commands.

RPTMON: Report Splitter Output Queue Monitor

DescriptionThe Output Queue Monitor is used to automatically monitor for new reports to split. This command can berun interactively or can be submitted to batch. Typically this option should be submitted to batch to run injob queue QBATCH or QSYSYNOMAX which is part of the QSYSWRK subsystem. Submitting the job toQSYSNOMAX allows the output queue monitor to run along with other AS/400 server jobs.

Example Output Queue Monitor command being submitted to batch to run once:SBMJOB CMD(RPTMON FILE(*TABLE) SPLFOPT(*MARK) OUTQ(QGPL/REPORTS)RUNMODE(*INTER) DELAY(*ONCE)) JOB(RPTMON)

Example Output Queue Monitor command being submitted to batch to run without ending. It will check fornew reports every 300 seconds (5 minutes):SBMJOB CMD(RPTMON FILE(*TABLE) SPLFOPT(*MARK) OUTQ(QGPL/REPORTS)RUNMODE(*INTER) DELAY(*DELAY) DLYTIM(300) ENDTIME(000000)) JOB(RPTMON)

Example Output Queue Monitor command being submitted to batch to run until 4:00pm. It will check fornew reports every 300 seconds (5 minutes):SBMJOB CMD(RPTMON FILE(*TABLE) SPLFOPT(*MARK) OUTQ(QGPL/REPORTS)RUNMODE(*INTER) DELAY(*DELAY) DLYTIM(300) ENDTIME(160000)) JOB(RPTMON)

Example Output Queue Monitor command running interactively:RPTMON FILE(*TABLE) SPLFOPT(*MARK) OUTQ(QGPL/REPORTS) RUNMODE(*INTER)DELAY(*ONCE)

From the RPTSPLIT menu, take option 4 to run the Output Queue Monitor or option 5 to run in batch.

42 •••• Chapter 5 – AS/400 Commands AS/400 Report Splitter Version 3.00 Users Guide

Figure 23 Output Queue Monitor - RPTMON

Command Parameters

Spool file run optionThis parameter is used to tell the output queue monitor which spool file entries to watch for in the sourceoutput queue. The following options are available:

• If a spool file name is entered, the specified spool file will be monitored for in the source output queue.When a matching spool file entry is found, the entire report will be sent to the selected user destination(s).

• If *ALLFILES is selected, all spool entries will be monitored for and will be sent to the selected userdestination(s). This is a nice way to reroute all reports from a specified output queue to another queue.

• The most versatile way to use the output queue monitor is to use the Report Distribution Table tomonitor and process selected entries. Using the Distribution Table, the page range selection and reportscanning capabilities of the Report Splitter can be utilized. To use the Report Distribution Table forselection, *TABLE must be specified for the run option.

After processing spool optionThis parameter is used to handle the source spool file after it has been processed by the output queuemonitor.

• If *DELETE is specified, the processed spool file is deleted after processing.• If *MARK is specified, the processed spool file will be marked with a USRDTA entry of *SENT.• If *MOVE is specified, the processed spool file will be moved to the output queue specified in the

MOVEOUTQ parameter. .• If *NONE is specified, no action is taken after processing the spool file.

Source output queueThis parameter is used to select the output queue to be monitored. Only one output queue can be monitoredper instance of the RPTMON command.


Destination output queueThe destination output queue can be any existing output queue on the local system. Up to ten destinationoutput queues can be selected.

If *TABLE is selected for the spool file run option selection, this field will not be displayed on theRPTMON command prompt and the destination output queue will be determined based on the settingswithin the Report Distribution Table.

Destination user identifierThe destination user identifier can be any valid SNADS user id that exists in the AS/400 system directory.Up to ten destination user identifiers can be selected. Most companies will not use SNADS unless they havemultiple interconnected AS/400 systems where reports will be sent.

If *TABLE is selected for the spool file run option selection, this field will not be displayed on theRPTMON command prompt and the destination output queue will be determined based on the settingswithin the Report Distribution Table.

Use the WRKDIR command to set up users in the AS/400 system directory.

Run modeEither *BATCH or *INTER can be selected to run the output queue monitor in batch mode or interactivemode.

If *BATCH is chosen, the job will be automatically submitted to the job queue specified on the Submit tojob queue parameter as soon as the Enter key is pressed after entering parameter information.

Note: As a general rule, don’t use the *BATCH setting. If you submit the output queue monitor from a jobscheduler or a CL program, *INTER should be used. This parameter will eventually be phased out.

*INTER should be chosen if the job will be run interactively, set up on an AS/400 job scheduler forautomatic processing or running the output queue monitor from a user job. This will ensure that the outputqueue monitor runs in line with the user processing and not in a separate job.

Submit to job queueJob queue that output queue monitor will be submitted to if *BATCH is chosen for the run mode. Use jobqueue QSYSNOMAX if you want the output queue monitor to run in the server subsystem QSYSWRK.

Routing dataIf the performance of the output queue monitor needs to be controlled, the routing data entry may be used togive the job a different priority by routing the job through a different subsystem routing entry.

Note: Do not change this entry unless you have an understanding of how subsystem routing entries work.

Delay processing or run onceEither *DELAY or *ONCE can be selected when running the output queue monitor to have it runcontinuously until a specified time or run only a single time.


Delay between cyclesThe delay between cycles parameter tells the output queue monitor how long to wait after each cycle whenrunning in *DELAY mode. The delay time is specified in seconds. The default value is 300 seconds or 5minutes between each cycle.

Time to end programThis parameter is used to specify an ending time when running in *DELAY mode. The end time is based ona 24 hour clock from 00:01:00 – 23:59:00 (12:00am – 11:59pm). The default value is 160000, which willend the monitor at 4:00pm.

Note: If you specify 000000, the output queue monitor will never end unless the job is ended via theENDJOB command. This setting can be used to run the output queue monitor continuously.

Spool file distribution groupThis parameter is used to specify a spool file distribution group to use for criteria selection when splittingreports with report monitor.

The spool file distribution group option is only utilized when *TABLE is selected for the spool file runoption selection.

Move to output queueThis parameter tells the report monitor the name of an output queue where all processed spool files will beautomatically moved if *MOVE is selected for the after processing spool option. A spool file will only bemoved if pages are selected for reprinting during the report monitor processing.

Select spool filesThis parameter can be used to limit the spool files that will be selected by the output queue monitor duringprocessing. The selection options are listed below:

Note: This parameter should not be used unless you have a reason to limit the spool files the output queuemonitor looks at. Filtering is better controlled via the Report Distribution Settings table entries.

• If *FILE is specified, the output queue monitor will only select entries where the spool file namematches the criteria entered in the spool selection criteria parameter.

• If *FORM is specified, the output queue monitor will only select entries where the spool file form typematches the criteria entered in the spool selection criteria parameter.

• If *USRDTA is specified, the output queue monitor will only select entries where the spool file userdata matches the criteria entered in the spool selection criteria parameter.

• If *USERID is specified, the output queue monitor will only select entries where the spool file user IDmatches the criteria entered in the spool selection criteria parameter.

• If *NONE is specified, no special filtering will take place during output queue monitor processing.

Spool selection criteriaThis parameter is used to specify special spool file criteria based on the option entered in the Select spoolfiles parameter.

Validate Directory EntriesIf SNADS users are specified as report recipients, this setting determines whether the AS/400 systemdirectory is checked before reports are split.*NO – The system directory is not checked.


*YES – The system directory is checked

Print Audit ListingThis setting is used to print an audit listing during output queue monitor processing. This setting shouldonly be used when troubleshooting.*NO – Do not create audit listing.*YES – Create audit listing.

WRKSPLIT: Work with Report Splitter

DescriptionThe WRKSPLIT command can be used to manually select and split reports. This command is handy ifusers will have a need to manually split reports from the AS/400 without running the Output QueueMonitor. This command can be added to user application menus to allow users to access the interactivesplitting functionality of the AS/400 Report Splitter software.

Figure 24 Work with Report Splitter Command Prompt


Figure 25 Work with Report Splitter Selection Screen – WRKSPLIT

Command Parameters

Output Queue/LibraryType the selected output queue and library name and press Enter to display the report selection screen.After the Report Selection Screen is displayed, place an Option 13 next to any report if you want to split itor Option 5 to display the report. When using Option 13, the interactive Report Splitter ParameterSelection screen will be displayed after selecting the option and pressing Enter.

Figure 26 Report Splitter Parameter Selection View 1


Figure 27 Report Splitter Parameter Selection View 2

Function KeysF3 = Exit

F4 = Prompt RPTSPLIT command.

F6 = Display completed RPTSPLIT command.

F8 = Submit RPTSPLIT command to batch.

F9 = Display spool file.

F10 = AS/400 command entry screen.

F11= Display additional parameters (Banner Page Info).

ENTER = Run RPTSPLIT command on selected report.

Screen Selection Parameters for RPTSPLIT

Spool file nameDisplay only. Automatically filled in by user selection.

Job nameDisplay only. Automatically filled in by user selection.

User nameDisplay only. Automatically filled in by user selection.

Job numberDisplay only. Automatically filled in by user selection.


Spool file numberDisplay only. Automatically filled in by user selection.

Comparison data range definitionComparison data range consists of two fields, which can contain up to a 30-character string that can bescanned for in the selected report. When the comparison data is found on a page, the entire page will bereprinted. The comparison data is used to reprint only the selected portion of a report. If a comparison datarange is selected, there can be no pages in between the comparison data range that contain data outside therange unless multiple compare occurrences is set to *YES.

Beginning compare dataThis is the Beginning comparison data string for the comparison data range. When scanning for a specificsales rep, customer, etc. a string value should be entered in this field. Special keywords can also be used.

Available special keyword options are listed below:

*NOSPLIT is used to reprint the entire report. This is a great way to duplicate an entire report to multiplerecipients.

*PAGERANGE is used to reprint a selected page range. This is a good way to split up a report betweenmultiple printers for printing.

*ALL decollates the entire spool file to a single output queue and splits the report into multiple reportsections each time the selected criteria changes. The criteria value is placed into the user data field, so thereports can be uniquely identified. This is a good way to break up a sales report or any other report intomultiple sections every time the selected criteria changes.

*ALL2 decollates the entire spool file to a single output queue and splits the report into multiple reportsections each time the selected criteria changes. The criteria value is placed into the user data field, so thereports can be uniquely identified. This is a good way to break up a sales report or any other report intomultiple sections every time the selected criteria changes.

Note: Zero line spacing has been known to cause endless looping problems when used with *ALL, so*ALL2 was created to handle this problem.

*SCANDHR can be selected to scan the first 100 lines of a report for the selected report criteria valuespecified in the Ending compare data field. If the substring is found anywhere within the first 100 lines ofthe report, the entire report will be reprinted.

*LASTPAGE can be used to distribute the last page of a report.

*TABLE can be selected to split the selected report based on the criteria data specified in the reportdistribution table. (See the Report Distribution Table chapter for more information.)

Note: All special keywords are CASE sensitive and must be entered in upper case.

Ending compare dataThis is the Ending comparison data string for the comparison data range. When scanning for a specific salesrep, customer, etc. a string value should be entered in this field.


*SAME will default the ending comparison data selection based on the beginning compare data.



Compare data lineCompare data line contains the report line that will be scanned for comparison data if a comparisonselection is made. If the comparison data line is 0, every line on a page will be scanned for the selectedcomparison data criteria.

Beginning compare data columnBeginning compare data column contains the beginning column position that is scanned if a comparisondata selection is made. The only report line that is scanned is the selected compare data line unless 0 isspecified.

Ending compare data columnEnding compare data column contains the ending column position that will be scanned if a comparison dataselection is made. The only report line that is scanned is the selected compare data line unless 0 is specified.

Spool File Distribution GroupSpool file distribution group is used to select a Report Distribution Group from the Report DistributionTable when *TABLE is specified for the beginning compare data selection. If this entry is left blank, allentries in the Report Distribution Table that correspond to the selected spool file will be processed.

Multiple compare occurrences*NO assumes that a report is pre-sorted based on the criteria that will be scanned for. Once the firstoccurrence of a criteria value is found, the report will be processed until the criteria changes and thenprocessing will stop. If there are additional pages that contain the selected criteria further into the originalreport, the pages will not be processed.

*YES assumes that all pages containing the selected criteria will be processed and included in the newreport regardless of how the report is sorted.

Example Scenario: A sales report sorted by sales rep is searched for sales rep 100 and data for sales rep100 occurs on pages 1-10 and 40-50.

By specifying *NO for multiple comparisons, only pages 1-10 will be included in the new report. This ismuch more efficient than *YES, however all pages for sales rep 100 were not included in the resultingreport.

By specifying *YES for multiple comparisons, pages 1-10 and 40-50 will be included in the new report.This will give sales rep 100 all of the correct report pages; however when *YES is used the entire reportmust be searched for rep 100, therefore using *YES is not as efficient as *NO.

Submit job queueSelected job queue where report will be split if the job is submitted to batch.

Submit on holdIf Y is chosen, the job will go on hold in the selected job queue if the job is submitted to batch.

Starting pageIf *PAGERANGE is selected on the beginning compare data parameter, this is the first page which will bereprinted.


Ending pageIf *PAGERANGE is selected on the ending compare data parameter, this is the last page which will bereprinted. Up to 9,999,999 pages can be selected.

Destination output queueDestination output queue can be any existing output queue on the local system. Up to ten destination outputqueues can be selected. If *TABLE is selected for the beginning compare data selection, this field will notbe used.


If *TABLE is selected for the spool file run option selection, this field will not be used.

Use the WRKDIR or WRKDIRE command to set up users in the AS/400 system directory.

Print Banner PageIf *YES is selected, a banner page will be printed at the beginning of the report when it is reprinted. If *NOis selected, no banner page will be printed.

Banner Page TestUp to 5 lines of text can be specified to print on the banner page if *YES is selected on the Print BannerPage parameter. If you will be emailing reports, you can specify the MAILTO: keyword on any of thebanner page lines to create an embedded email address within the report.


RPTSPLIT: AS/400 Report Splitter Command

DescriptionThe RPTSPLIT command can be utilized by user applications to split reports. This command is also calledfrom the WRKSPLIT report selection screen.


Figure 28 Report Splitter Command - RPTSPLIT

Command Parameters

Spool file nameEnter the selected AS/400 spool file name. This information can be determined by using the WRKOUTQcommand to display a report list.

Job Name/User Name/Job NumberEnter the selected spool file job name, user name and job number. This information can be determined byusing the WRKOUTQ command to display a report list.

Spool File NumberEnter the selected spool file number. This information can be determined by using the WRKOUTQcommand to display a report list.

Other valid values are *ONLY and *LAST. *ONLY will select the spool file if it’s the only spool file in theselected job. *LAST will select the most recent spool file in the selected job.

Comparison data range definitionComparison data range consists of two fields, which can contain up to a 30-character string that can bescanned for in the selected report. When the comparison data is found on a page, the entire page will bereprinted. The comparison data is used to reprint only the selected portion of a report. If a comparison datarange is selected, there can be no pages in between the comparison data range that contain data outside therange unless multiple compare occurrences is set to *YES.


Beginning compare dataThis is the Beginning comparison data string for the comparison data range. When scanning for a specificsales rep, customer, etc. a string value should be entered in this field. Special keywords can also be used.


*NOSPLIT is used to reprint the entire report. This is a great way to duplicate an entire report to multiplerecipients.

*PAGERANGE is used to reprint a selected page range. This is a good way to split up a report betweenmultiple printers for printing.

*ALL decollates the entire spool file to a single output queue and splits the report into multiple reportsections each time the selected criteria changes. The criteria value is placed into the user data field, so thereports can be uniquely identified. This is a good way to break up a sales report or any other report intomultiple sections every time the selected criteria changes.

*ALL2 decollates the entire spool file to a single output queue and splits the report into multiple reportsections each time the selected criteria changes. The criteria value is placed into the user data field, so thereports can be uniquely identified. This is a good way to break up a sales report or any other report intomultiple sections every time the selected criteria changes.

Note: Zero line spacing has been known to cause endless looping problems when used with *ALL, so*ALL2 was created to handle this problem.

*SCANDHR can be selected to scan the first 100 lines of a report for the selected report criteria valuespecified in the Ending compare data field. If the substring is found anywhere within the first 100 lines ofthe report, the entire report will be reprinted.

*LASTPAGE can be used to distribute the last page of a report.

*TABLE can be selected to split the selected report based on the criteria data specified in the reportdistribution table. (See the Report Distribution Table chapter for more information.)


Ending compare dataThis is the Ending comparison data string for the comparison data range. When scanning for a specific salesrep, customer, etc. a string value should be entered in this field.


*SAME will default the ending comparison data selection based on the beginning compare data.


Multiple compare occurrences*NO assumes that a report is pre-sorted based on the criteria that will be scanned for. Once the firstoccurrence of a criteria value is found, the report will be processed until the criteria changes and thenprocessing will stop. If there are additional pages that contain the selected criteria further into the originalreport, the pages will not be processed.


*YES assumes that all pages containing the selected criteria will be processed and included in the newreport regardless of how the report is sorted.

Example Scenario: A sales report sorted by sales rep is searched for sales rep 100 and data for sales rep100 occurs on pages 1-10 and 40-50.

By specifying *NO for multiple comparisons, only pages 1-10 will be included in the new report. This ismuch more efficient than *YES, however all pages for sales rep 100 were not included in the resultingreport.

By specifying *YES for multiple comparisons, pages 1-10 and 40-50 will be included in the new report.This will give sales rep 100 all of the correct report pages; however when *YES is used the entire reportmust be searched for rep 100, therefore using *YES is not as efficient as *NO.

Compare data lineCompare data line contains the report line that will be scanned for comparison data if a comparisonselection is made. If the comparison data line is 0, every line on a page will be scanned for the selectedcomparison data criteria.

Beginning compare data columnBeginning compare data column contains the beginning column position that is scanned if a comparisondata selection is made. The only report line that is scanned is the selected compare data line unless 0 isspecified.

Ending compare data columnEnding compare data column contains the ending column position that will be scanned if a comparison dataselection is made. The only report line that is scanned is the selected compare data line unless 0 is specified.

Starting pageIf *PAGERANGE is selected on the beginning compare data parameter, this is the first page which will bereprinted.

Ending pageIf *PAGERANGE is selected on the ending compare data parameter, this is the last page which will bereprinted. Up to 9,999,999 pages can be selected.

Destination output queueDestination output queue can be any existing output queue on the local system. Up to ten destination outputqueues can be selected. If *TABLE is selected for the beginning compare data selection, this field will notbe displayed on the RPTSPLIT command prompt because all information will be selected from the ReportDistribution Table.


If *TABLE is selected for the spool file run option selection, this field will not be displayed on thecommand prompt and the destination user identifier will be determined based on the settings within theReport Distribution Table.




Banner Page TestUp to 5 lines of text can be specified to print on the banner page if *YES is selected on the Print BannerPage parameter. If you will be emailing reports, you can specify the MAILTO: keyword on any of thebanner page lines to create an embedded email address within the report.


Spool File Distribution GroupSpool file distribution group is used to select a Report Distribution Group from the Report DistributionTable when *TABLE is specified for the beginning compare data selection. If this entry is left blank, allentries in the Report Distribution Table that correspond to the selected spool file will be processed.

Validate Directory EntriesIf SNADS users are specified as report recipients, this setting determines whether the AS/400 systemdirectory is checked before reports are split.*NO – The system directory is not checked.*YES – The system directory is checked

RPTMRG: Report Splitter Merge Command

DescriptionThe report merge command is used to merge selected report files within a selected output queue into asingle spool file. Some users may want to do this for easier report distribution.

Note: All reports in the source output queue must have the same spool file attributes such as page length,width, characters per inch, lines per inch, etc. The attributes from the first spool file selected from thesource output queue will be used when creating the new spool file during the merge processing.


Figure 29 Report Splitter Merge Command - RPTMRG

Command Parameters

Source output queueThis parameter is used to select the source output queue that will be merged into a single spool file.

Destination output queueThe destination output queue can be any existing output queue on the local system. Up to ten destinationoutput queues can be selected. The destination output queue will receive the merged spool file.




Banner Page TextUp to 5 lines of text can be specified to print on the banner page if *YES is selected on the Print BannerPage parameter. If you will be emailing reports, you can specify the MAILTO: keyword on any of thebanner page lines to create an embedded email address within the report.Example: MAILTO: [email protected]


Validate Directory EntriesIf SNADS users are specified as report recipients, this setting determines whether the AS/400 systemdirectory is checked before reports are split.*NO – The system directory is not checked.*YES – The system directory is checked

Select spool fileIf entered, only reports in the source output queue that match the selected spool file name will be processed.This is a good way to limit which reports get included when the report merge process is run.

Select user dataIf entered, only reports in the source output queue that match the selected user data value will be processed.This is a good way to limit which reports get included when the report merge process is run.

Select user idIf entered, only reports in the source output queue that match the selected user id will be processed. This isa good way to limit which reports get included when the report merge process is run.

Select job nameIf entered, only reports in the source output queue that match the selected job name will be processed. Thisis a good way to limit which reports get included when the report merge process is run.

Select form typeIf entered, only reports in the source output queue that match the selected form type will be processed. Thisis a good way to limit which reports get included when the report merge process is run.

New spool fileIf entered, the new spool file created by the report merge process will have the spool file name specified.This is a good way to provide unique spool file names for new reports created by the report merge process.

New user dataIf entered, the new spool file created by the report merge process will have the user data specified. This is agood way to provide unique user data for new reports created by the report merge process.

New form typeIf entered, the new spool file created by the report merge process will have the form type specified. This is agood way to provide unique form types for new reports created by the report merge process.

After processing spool optionThis parameter is used to handle the source spool file after it has been processed by the report mergeprocess.

• If *DELETE is specified, the processed spool file is deleted after processing.• If *MARK is specified, the processed spool file will be marked with a USRDTA entry of *SENT.• If *MOVE is specified, the processed spool file will be moved to the output queue specified in the

MOVEOUTQ parameter. .

• If *NONE is specified, no action is taken after processing the spool file.


Move to output queueThis parameter tells the report merge process the name of an output queue where all processed spool fileswill be automatically moved if *MOVE is selected for the after processing spool option. A spool file willonly be moved if pages are selected for reprinting during the report merge processing.

RPTNUM: Retrieve Spool File Name/Number

DescriptionThe RPTNUM command can be utilized by user applications to retrieve the spool file job information for aselected report before it’s split with the RPTSPLIT command.

Figure 30 Retrieve Spool File Name/Number -RPTNUM

Command Parameters






Return Spool FileThis parameter will return a 10-character spool file name for the selected spool.

Return Job NameThis parameter will return a 10-character job name for the selected spool.

Return Job UserThis parameter will return a 10-character user name for the selected spool.

Return Job NumberThis parameter will return a 6-character job number for the selected spool.

Return Spool NumberThis parameter will return a 4-character spool file number for the selected spool.

RPTREPRINT: Reprint Spool file

DescriptionThe reprint spool file command can be used to reprint a spool file with different print attributes. This maysometimes be necessary if a report was printed with the wrong CPI (characters per inch) setting or with anyother invalid printer attribute. The RPTREPRINT command is an AS/400 Report Splitter utility command.

Figure 31 Report Reprint Command - RPTREPRINT






Change printer attributesIf *YES is selected, the AS/400 OVRPRTF (Override with Printer File) command will be prompted forbefore the spool file is reprinted. Any allowable parameter on the OVRPRTF command may be changed sothe report is reprinted with the selected printer attributes. If *NO is selected, the report is reprinted with thesame printer attributes.

RJSWRKOUTQ: RJS Work with Output Queue

DescriptionThe RJS Work with Output Queue command can be used as a replacement for the Work with Output Queuecommand: WRKOUTQ. The command displays a list of reports for the selected output queue and also hasoptions available for emailing a report, converting a report, faxing a report or splitting a report with theReport Splitter.

Figure 32 RJS Work with Output Queue


Command Parameters

Output Queue/LibraryType the selected output queue and library name and press Enter to display the report selection screen.

RJSWRKSPLF: RJS Work with Spooled Files

DescriptionThe RJS Work with Spooled Files command can be used as a replacement for the Work with Spooled Filescommand: WRKSPLF. The command displays a list of reports for the selected user and also has optionsavailable for emailing a report, converting a report, faxing a report or splitting a report with the ReportSplitter.

Figure 33 RJS Work with Spooled Files

Command Parameters

UserType the selected user name or leave the default of *CURRENT to display a report list for the current user.

Output queueType the selected output queue to filter the report list by output queue.

Form typeType the selected form type to filter the report list by form type.


User dataType the selected user data if you want to filter the report list by user data.

AS/400 Report Splitter Version 3.00 Users Guide Chapter 6 Problem Handling •••• 63

Chapter 6 Problem Handling

Common Errors1. If you get an error when running the output queue monitor, make sure to review the Entering

Operating System Specific Settings section in the Installation chapter of the manual and run theRPTOS command in the RPTSPLIT30 directory to make sure the API length is set correctly.

2. If you are using a special keyword such as *ALL, *NOSPLIT, *PAGERANGE, etc. and the reportdoesn’t split correctly, make sure the keywords are being typed using capital letters. All of the specialkeywords are CASE sensitive.

3. If you are splitting a report using specific selection criteria and the report does not split, make sure touse the WRKOUTQ or WRKSPLF commands to select and view the report and verify that the pageline you’re scanning on is correct. Also, see the Getting Started section for instructions on how toidentify page/line breaks within a report.

4. If the report splitter seems to loop endlessly when you are using the *ALL option, you most likely aretrying to split a report that contains zero line spacing in it on the line that’s being scanned for criteria.You should either specify a different line number to scan on or try using the *ALL2 option whichignores zero line spacing when processing a report.

5. If the RPTNUM command fails with a MCHxxxx error during processing, you probably need to assignthe return values from your CL program as mentioned in the sample CL program provided by RJS. Allreturn values for RPTNUM need a variable assigned to them. See the Getting Started section for theCL sample program.

6. If a report is not going to the correct output queue when it gets reprinted, make sure all print overrideshave been removed prior to calling the Report Splitter processing. Any time an OVRPRTF command isused it should be followed with a DLTOVR command immediately after the report is generated, butbefore the Report Splitter processing is called. You can also use the DSPOVR command to displayprinter overrides for an interactive AS/400 job.

Other ErrorsIf you cannot resolve the problem you're experiencing by using the previous troubleshooting methods, youshould contact RJS Software Systems for advice on solving the problems you're experiencing. See theTechnical Support section at the beginning of the User's Guide for information on contacting RJS SoftwareSystems.

AS/400 Report Splitter Version 3.00 User Guide

Documents

Transcript of AS/400 Report Splitter Version 3.00 User Guide