167
WebReport/i Version 14.00 As of October 2020 Kisco Information Systems 89 Church Street Saranac Lake, New York 12983 Phone: (518) 897-5002 FAX: (518) 897-5003 E-mail: [email protected] WWW: http://www.kisco.com Customer Support: http://www.kisco.com/webreport/support © 1998-2020 Kisco Information Systems

WebReport/i · 2020. 10. 6. · IBM i OS options installed on your system including the QShell option and all Java options.! When converting a spool file to Excel format, a new option

  • Upload
    others

  • View
    4

  • Download
    0

Embed Size (px)

Citation preview

  • WebReport/i

    Version 14.00

    As of October 2020

    Kisco Information Systems89 Church Street

    Saranac Lake, New York 12983

    Phone: (518) 897-5002FAX: (518) 897-5003E-mail: [email protected]: http://www.kisco.comCustomer Support: http://www.kisco.com/webreport/support

    © 1998-2020 Kisco Information Systems

  • Table Of Contents

    Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1What’s New In Release 14 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1What’s New In Release 13 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

    What’s New In Release 13.10 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3What’s New In Release 13.12 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

    Additional Release 14 Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3Installation and Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4Pre-Requisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4Kisco Software Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4World Wide Web Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

    The Master Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

    Send Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9Send Report via E-mail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

    Email Routing Using Addresses in the Spool File . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33Email Routing Based On Report Content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35Send Multiple Reports in a single E-mail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

    EREPORTM Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40EFILE Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

    Send Report by Fax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44Send Report to System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46FTP Converted Spool Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64Review System Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66Work with WebReport/i Spool Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67Maintain Address Book . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69

    Working with Address Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72Restore *ISV Spool File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74Maintain XLS Report Models . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76

    CHKXMOD API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80Digital Signing for PDF Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81

    IBM OS Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81WebReport/i Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81Create Your Signing Certificate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82Applying The Digital Signature . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84

    Automatic Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87Automatic Routing Table Updates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87

    Update System Routing Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87Adding a new System Routing Instruction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89Changing, Copying, Deleting and Reviewing System Routings . . . . . . . . . . . . . . . . . 106Update E-mail Routing Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107Adding a new E-mail Routing Instruction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108Changing, Copying, Deleting and Reviewing E-mail Routings . . . . . . . . . . . . . . . . . 125Automatic Routing by User Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126Automatic Routing Using *USRDFNDTA Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126

    Starting Automatic Routing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127Ending Automatic Routing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127Activity Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127

    The Monitor Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130Message Monitors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130File Monitors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135

    Installation and Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138Installation from Media . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138Release Upgrade Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139Installation from Internet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139

  • 3

    Configuration Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140Considerations for using Internet Addresses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141Control over ASCII Conversion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142

    The Install Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143Display installation status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145Change installation status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145Permanent installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146Print additional documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147Display Software Version Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147Title Conversion Table Maintenance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148Install Kisco PTF Package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151Update WebReport/i Directory Info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152Update WebReport Default Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152WebReport/i Configuration Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158SMTP Journal Tracing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160User Profile Security Maintenance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162Send Test Email . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164

  • 1

    Introduction

    WebReport/i is an e-business application for your IBM i computer system which includes PowerSystems running IBM’s i/OS, i5, iSeries and AS/400. It lets you to take reports from yoursystem’s print spool and electronically deploy them. WebReport/i will let you send these reportsas E-mail or fax. It will also let you convert the reports into various format documents fordeployment on either your own company Intranet or to an Internet Website. A full functionedIntranet website deployment using the IBM i/OS Apache server is included with the software. Details about the Intranet feature are included in a separate manual. With Release 13, an interfaceto Google Drive, a cloud report sharing service, is also included. The Google Drive feature is alsodocumented in a separate user’s guide. With Release 13.1, an interface to Dropbox is alsoincluded which is also documented in a separate user’s guide.

    For the purposes of this documentation, your system will be referred to as an “iSeries” system. This term is used generically and applies to all systems in the IBM i family, including your PowerSystem running IBM i/OS, i5 system, your AS/400 system or your iSeries.

    Overview

    WebReport/i processes your iSeries print spool and extracts reports. It can be run manually on areport by report basis, imbedded directly into your own programs using our standard IBM i/OScommands or you can set it up to run automatically. When run manually, you simply identify thespool file that you want to process. By choosing one of two commands, you can either send thespool file as an E-mail or fax, or your can convert it into a document for web deployment. As analternative, you can use the Work With Web Spool Files (WRKWEBSPLF) command to reviewspool file contents and choose WebReport/i options for them.

    When setup for automatic operation, all you need to do is create routing instructions withinWebReport/i. These instructions are associated with specific output queues on your iSeriessystem. To have something route automatically, you just route the output to the output queue andthe WebReport/i router will take over from there.

    Each operation performed by WebReport/i is logged to an activity database within WebReport/i. You can use this to trace activity and see what reports are being processed and how they are beingprocessed. A utility provided with WebReport/i will let you periodically print out this log to clearthe log and review the entries made in it.

    What’s New In Release 14

    Release 14 of WebReport/i includes the following changes and new features. Some of these wereintroduced during the life cycle of the previous release, so current customers may already havesome of this functionality already installed.

    ! With Release 13.11 (PTF WRPTF1311), WebReport/i now supports pushing convertedreports out to Dropbox accounts in Cloud storage. For this feature, there are additionalconfiguration requirements. There is a new and separate documentation manual nowavailable that covers this new feature. It is available from the download website forWebReport/i at the www.kisco.com website.

  • 2

    ! A terminology change has been made for WebReport/i. Prior to this change, the process toconvert a spool file and store it on your IBM i system was generally referred to as an HTML process. This has led to customer confusion at times over the years. Now, thisprocess is referred to as a System report routing. All menu and screen references inWebReport/i have now been updated to use the new terminology. The WebReport/i user'sguide and certain related feature guides have also been updated.

    ! A new option for controlling the report title and destination email addresses has been addedon the EREPORT command. See the *USRDFNALT option in this manual.

    ! An optional alert message can be issued when an error occurs in WebReport/I.

    ! The FTP option has been enhanced to allow you to use a specific port number for your FTPserver connection.

    ! New horizontal and vertical scaling options have been added for PDF conversionprocessing.

    ! An email test option has been added to the INSTALL menu.

    ! An option has been added to allow you to format the body text of an email in HTML ratherthan just plain text.

    ! The Report Intranet feature will now let you add your own files to be available via theIntranet, not just converted spool files.

    ! The Work With Web Spool Files (WRKWEBSPLF) command has been enhanced.

    ! The security functions in WebReport/i have been improved.

    What’s New In Release 13

    Release 13 of WebReport/i includes the following changes and new features. Some of these wereintroduced during the life cycle of the previous release, so current customers may already havesome of this functionality already installed.

    ! Google Drive feature added. Some customers may be familiar with this as Google Docs,which is a previous name used by Google for the feature. This lets you transfer yourreports into Google’s cloud storage service and share them there.

    ! Report distribution splitting (or bursting) can now be done based on information containedin the report. Using this feature, you can separate sections of a report, for example, bysalesman number or account number and the relevant sections of the report will be senttheir separate ways depending on how you have this implemented.

    ! New attachment file naming options have been added.

    ! A new command, EFILE, has been added and you can use it to send any file stored in theIFS as an email attachment. The command supports sending up to 5 such files in a singleemail message.

  • 3

    ! The Report Intranet feature has been upgraded to allow end users to delete reports from theIntranet when such users have been previously authorized to do so in WebReport/i.

    ! Throughput for automatic routing has been improved with the option of adding additionalreport processing agents in the automatic routing feature.

    ! An easier to use SMTP tracing listing has been added

    ! Excel report conversions have been secured by the addition of a password (or pass phrase)option. The end user can still open the spreadsheet, but they will need to know thepassword before they can change any contents.

    What’s New In Release 13.10

    Release 13.10 of WebReport/i is an interim release and includes the following changes and newfeatures.

    ! Support added for Excel 2007 and later .XLSX file formats. This allows for largerspreadsheet file to be extracted from large report spool files.

    ! Option added to allow a file to be compressed using standard “zip” technology beforebeing sent as an email attachment. Use of this feature requires that you have additionalIBM i OS options installed on your system including the QShell option and all Javaoptions.

    ! When converting a spool file to Excel format, a new option allows you to ignore standardfooter lines from the conversion.

    ! New optional global setting that will cause all Excel conversions already set up to use thenew Excel 2007 .XLSX format option.

    What’s New In Release 13.12

    Release 13.12 of WebReport/i includes a new interface with the Dropbox cloud storage facility.

    Additional Release 14 Documentation

    In addition to this manual, WebReport/i has several additional smaller user guide’s available forspecific features as follows:

    Report Intranet FeatureGoogle Drive FeatureDropbox FeaturePDF Fill-in Forms Feature

    These manuals are separate from this general use guide and are focused on the specific featuresindicated. They are available on the install CD that you received from Kisco or you can get themvia download at the Kisco website for WebReport/i.

  • 4

    Installation and Security

    Specific installation instructions are covered in the section of this manual titled "Installation". Toinstall your product on trial, follow those instructions. WebReport/i can be installed fromdistribution media supplied by Kisco Information Systems or from a download file from theInternet. The initial installation will allow WebReport/i to run on your system for a period of atleast thirty days. At the end of the trial period, the software will no longer function.

    When you decide to keep WebReport/i, you must send your payment to Kisco InformationSystems. At that time, Kisco must know the full serial number for your system and the partitionnumber where you have the software installed. If you are not sure of your serial number orpartition number, you can display this information by running option #2 on the INSTALL menu inthe application library WEBREPORT.

    When Kisco receives your payment and serial number/partition number, they will issue a passwordto you. This password, when applied, will certify your copy of WebReport/i and will permanentlyactivate the software on your system. The password and certification instructions will be providedin writing by email.

    Pre-Requisites

    WebReport/i assumes that you have the following components in place on your system:

    ! A working TCP/IP environment on the iSeries.! An active SMTP (Simple Mail Transport Protocol) server function running on the iSeries

    (for use of the E-mail features in WebReport/i only).! A working E-mail server. This may be on the iSeries or an external mail server. For

    Internet destination E-mail addresses, the mail server must be connected to the Internet.! To use the fax output option, you must have an active account with MetroFax or a similar

    internet fax service. See details in the fax output section of this manual.! To use the Google Drive feature, you must have an active account with Google. This

    account can be obtained at no charge initially during your testing period. Keep in mindthat the free account will have a limit on the total size of reports stored there.

    ! To use the Dropbox feature, you must have an active account at Dropbox and also an activeaccount at IFTTT (If This Then That). Details about this are in the separate documentationthat is specific to the Dropbox feature.

    ! To use the optional email attachment compression feature (zip), you will need to haveadditional IBM i OS options installed including the QShell option and all Java options.

    Additional information about each of these components is discussed later in the manual under theInstallation and Configuration section. Configuration help is available by using the ConfigurationWizard function.

    Kisco Software Support

    Kisco Information Systems software support is available from 7am to 6pm eastern time. You canreach software support with the following methods:

    Phone: 518-897-5002Email: [email protected]: 518-897-5003

    mailto:[email protected]

  • 5

    Mail: Kisco Information Systems89 Church StreetSaranac Lake, NY 12983

    Off-hours support can be provided for all registered customers with advance notification. Contactour support staff at least 24 hours in advance when you think you will need off-hours support andwe will provide instructions for contacting us during that time. If you have unscheduled off-hourssupport needs, you should place a phone call and send an email request. Support is generallyavailable during off-hours although there may be a delay in response time.

    Kisco Information Systems provides unlimited software support during your first year ofownership. This includes the time during your free trial. Following the first year of ownership,there is a modest fee structure to maintain support for your software.

    The Kisco support policy program works as follows:

    1. First year support will continue to be FREE! This will include unlimited telephonesupport, unlimited E-mail support, free release updates and free license transfers.

    2. After the first year, an annual charge will apply for support and software maintenance.

    3. The annual fee will be charged at the rate of 15% of the then current selling price.

    4. Support covered by this annual fee includes:

    a. Unlimited telephone support (518-897-5002)b. Unlimited E-mail support ([email protected])c. Defect analysis and correctiond. Free updates to correct known defects (Kisco PTFs)e. Free updates for new releases and featuresf. Free license transfers (when you upgrade to a different system)

    At the end of your first year of ownership, you will receive an invoice from us for your next year'smaintenance charge. Non-payment of this invoice will be taken to mean that you declinemaintenance.

    World Wide Web Support

    You can use the World Wide Web to reach us and to obtain software support information. Just setyour web browser to our web address at:

    http://www.kisco.com

    Support information specifically for WebReport/i can be found at this address:

    http://www.kisco.com/webreport/support

    At our Website, you will find:

    ! Product information about all Kisco software products for the IBM i.

  • 6

    ! Customer support information including:

    < Latest release level information for all products< Technical bulletins< Frequently asked questions and answers< Problem reports including WebReport/i PTF availability< Descriptions for recent enhancements to products< E-mail contact information for getting in touch with us

    ! Information about consulting services available from Kisco Information Systems.

    ! Registration for automatic notification about WebReport/i enhancements and changes.

    ! ..... and more

    The first time you visit the Customer support section of our website for WebReport/i, be sure toregister for automatic notification. Once you are registered, we will automatically send Emailnotices to you about upgrades, enhancements and fixes for WebReport/i as soon as they becomeavailable.

    We invite you to visit our Website, use the contact features to let us know what you think. We'realways looking for ways to better serve you, our customer.

  • 7

    The Master Menu

    The main menu used by WebReport/i is called MASTER and is found in the libraryWEBREPORT. There are several ways to display the menu. You can issue the following GOcommand from any terminal command line:

    GO WEBREPORT/MASTER

    This method does not require that the library name be added to your library list. You can also addthe library to your library list and display the menu with an easier format. To add the library toyour library list and display the menu, enter the following two commands:

    ADDLIBLE WEBREPORTGO MASTER

    The main WebReport/i menu appears as follows:

    Each menu option handles the following functions. Each function is described in more detail laterin this manual:

    1. Send Report via E-mail Sends a specific iSeries spool file entry as an E-mail messageto a virtually unlimited number of recipients. This option isalso used to send your spool file by fax.

    2. Send Report to System Converts a specific iSeries spool file entry into a documentfor deployment on an Intranet or Internet Website.

    3. Review System Index Browse and maintain current System document list.

  • 8

    4. Work with WebReport/i Displays spool file entries and lets you choose various Spool Files WebReport/i options for them.

    5. Maintain Address Book Lets you maintain a list of frequently used E-mail addressesso that they can be referred to using abbreviations. Thisoption also allows you to create and maintain address groups.

    6. Restore *ISV Spool File Lets you restore a spool file from a PC file previously savedusing the *ISV format.

    7. Work With PDF Forms Lets you maintain configuration for the PDF Forms feature. Refer to the separate user manual available for this feature.

    8. Maintain XLS Report Models Lets you maintain report model settings for Excel spool fileconversion processing.

    15. Start Automatic Routing Starts WebReport/i's automatic report routing process.

    16. End Automatic Routing Stops the automatic report routing process. If there are nomessage monitors active, this will also close down theEREPORT subsystem.

    17. Update System Routing Table Updates and maintains System routing instructions for theautomatic process.

    18. Update Email Routing Table Updates and maintains Email routing instructions for theautomatic process.

    19. Display/Print Activity Log Displays or Prints and clears the WebReport/i activity log.

    20. To Monitor Menu Switches to the WebReport/i Monitor tasks menu.

    30. To Install Menu Switches to the WebReport/i Installation tasks menu.

    90. Signoff Performs a terminal signoff operation. (Option not displayedon the menu.)

  • 9

    Send Reports

    Send Report via E-mail

    You can send any *SCS spool file entry as an E-mail message using WebReport/i. You can alsochoose to send any *AFPDS, *IPDS or *USERASCII spool file if you use the PDF option to sendit in Acrobat format. If your *AFPDS spool file includes an overlay, the overlay will also beincluded in the email that is sent. Some color overlays are supported, contact Kisco for specificinstructions for color.

    Choose menu option #1 or enter the command WEBREPORT/EREPORT and press F4. Thefollowing screen will be displayed:

    The parameters on the screen can be completed as follows:

    Spooled File Name Enter the name of the spool file to be sent. You can alsospecify a special value of *NONE. When you do this, anEmail message will be sent with no attached report. To usethis option, the following additional conditions must be met:1) The output format must be set to *TXT2) You cannot use any of the special values allowed for theTITLE parameter.

    Job Name Enter the three qualifiers for the job, job name, user profileand system job number. If you use the special value of*CURRENT, then the spool file from your current job will be used. When use *CURRENT, leave the rest of the elements ofthis parameter blank.

  • 10

    Spooled File Number Enter the file number for the spool file to be sent. Thisparameter will also accept the following special values:

    *ONLY - the only spool file for the job will be used.*LAST - the most recent spool file for the job will be used

    Report Title Enter a short title for the report, up to 50 characters. This willbecome the Email “Subject” field. The following specialvalues are also available for this parameter:

    *USRDTA The title will be taken from the User Data fieldfor the spool file entry.

    *USRDFNDTA - the title will be taken from the first 50characters of the USRDFNDTA parameterassociated with the spool file being processed. If WebReport/i finds this value blank, a defaulttitle of “No User Defined Data Available” willbe used.

    *USRCNV The Subject for your email will be extractedfrom the Title Conversion Table based on thecontents of the USRDTA field for the spoolfile.

    *FILCNV The Subject for your email will be extractedfrom the Title Conversion Table based on thename of the spool file.

    *FRMCNV The Subject for your email will be extractedfrom the Title Conversion Table based on theformtype for the spool file.

    This field also supports special “macro” expressions asfollows:

    &DATE-EXPR

    If you encode the macro value of ‘&DATE-EXPR’ anywherein the report title field, WebReport/i will replace that fieldwith the current system date using your configured dateformatting.

    Example:

    “Sales Report for &DATE-EXPR”

    will be converted to the following value by WebReport/i:

    “Sales Report for 10/02/2015”

    &USRDTAFLD

    If you encode the macro value of ‘&USRDTAFLD’ anywherein the report title field, WebReport/i will replace that fieldwith the current contents of the user data field on the spool filebeing processed:

  • 11

    Example:

    If you store the invoice number in the user data field, then youcan use the following TITLE value:

    “Invoice number &USRDTAFLD”

    WebReport/i will substitute so that is looks like this:

    “Invoice number 19015”

    Attachment Format Specifies how you want the report sent. Choose one of thefollowing options:

    *TXT The spool file will be converted into a plain text file.*RTF The spool file will be converted into a Rich Text

    Format file (RTF). The RTF format can be used bymost PC-based word processing software. Choosingthis option will provide report recipients with a bettermethod of printing reports locally.

    *PDF The spool file will be converted into a Adobe AcrobatFormat file (PDF). The PDF format can be viewed onPC’s using the Adobe Acrobat Reader which isavailable for free from Adobe. This reader can be usedto view and print reports on PC’s and Macintoshcomputers.

    *XLS The spool file will be converted into an Excelspreadsheet file. (.xls)

    *XLX The spool file will be converted into an Excel 2007compatible spreadsheet file. (.xlsx)

    *CSV The spool file will be converted into a CommaSeparated Values PC file. This is a common formatfor interchange with an electronic spreadsheet.

    *TIF The spool file will be converted into TIF graphicformat

    *ISV The spool file will be converted into a new specialformat so that it can be restored to any iSeries systemand put back into an output queue (preferred over*ISP).

    *ISP The spool file will be converted into special format sothat it can be restored to any iSeries system and putback into an output queue. (This option still issupported but no longer recommended - use the *ISVoption.)

    Note: The *PDF, *XLS, *XLX, *CSV, *TIF, *ISV and *ISPoptions are only available when WebReport/i PDF isinstalled.

    Attachment file name Use this parameter to control how the email attachment file isnamed. You can specify a specific attachment file name (of upto 50 mixed case characters) or you can use one of thefollowing special values:

  • 12

    *GEN This is the default value. WebReport/i willautomatically assign a name to the attachmentfile.

    *GENDAT WebReport/i will assign a date differentiatedfile name using the two letter *GENDATfilename prefix code plus the create date for thespool file being processed.

    *USRDTA Webreport/i will use the contents of the UserData Field in the spool file as the filename withthe correct extension appended. For example,if the User Data Field contains the value“PGM0100CX” and you are converting a file inthe *PDF format, then the attachment file namewill be “PGM0100CX.PDF”.

    Sender Identifier Choose one of the following values to have this email messageidentified:

    *DFT The sender will be identified using the default settings from the WEBSET command (option#9 on the INSTALL menu) that was enteredwhen the software was installed andconfigured.

    *USER The sender will be identified using the currentuser profile and the default email address fromthe WEBSET command.

    *SPLUSER The sender will be identified as the user that isassociated with the spool file being processed. If that user profile is found in the WebReport/iAddress Book, then the sender’s full name asshown in the Address Book will be used. Using this option will have your email appearto be arriving from the person who actually ranthe report.

    Name If an address book abbreviation name is used,then the sender will be identified with both thename and email address that corresponds to thename entered. The information will be takenfrom the WebReport/i address book file.

    Email Enter any valid email address. The emailaddress entered here will be used as the sender'semail address. The sender's name will be takenfrom the system default value shown in theWEBSET command.

    Abbrev Enter a valid address abbreviation from theWebReport/i Address Book. The sender's

  • 13

    name and email address will be used based onthe Address Book record.

    Recipient Identifier This parameter identifies the recipient for this email message. Choose one of the following values:

    *DFT The default value specified by the WEBSETcommand is used.

    Name Enter the specific value that you want to use toidentify the recipient for this email.

    Additional parameters are needed for this command. When the above parameters have beencompleted, use the Roll function to display the next panel. It will appear as follows:

    To complete the command, enter these parameters as follows:

    Internet Address Provision is made for up to 20 fields of direct internet addressinformation.

    Addresses can take the following forms:

    Direct Addresses - these are in standard form such as“[email protected]

    WebReport/i Abbreviations - use any abbreviation name thatyou have already entered into the WebReport/i Address Book. When you use this form of addressing, the recipient’s name

    mailto:�[email protected]

  • 14

    will be encoded in the email message as it appears in theAddress Book.

    Multiple E-mail addresses can be stacked together within eachof the 20 parameter fields provided. You can stack DirectAddresses mixed with WebReport/i Abbreviations. To stackaddresses, just place a semi-colon (‘;’) between the addresseswithout leaving any blank characters.

    Example: [email protected];JOHN;[email protected]

    In the above example, the report will be sent to the two directinternet addresses shown and to the E-mail address associatedwith the WebReport/i abbreviated name JOHN.

    In addition to these options, you can also use one of thefollowing special values:

    *INT

    If you are processing a spool file that contains imbeddedinternal #EMAIL directive statements, this parameter shouldbe set to the special value ‘*INT’.

    You can also specify automatic routing using an email address(or string of email addresses) taken from the USRDFNDTAfield in the spool file itself. To do this, have your printingapplication store the addresses in the spool file field, thenspecify the special value of *USRDFNDTA in this parameter.

    Another option is to use the *USRDFNALT option. This willlet you place an email subject and destination email address(or addresses) in the USRDFNDTA field in the spool file. Positions 1-50 in the field will be considered the EmailSubject and positions 51-250 will be the destination emailaddress. You can stack multiple addresses if needed.

    Optional message text This field lets you add text that will be sent along with thereport in the body of the E-mail message. Using the *DFToption will send a default standard E-mail text to eachrecipient. The default text is set on the INSTALL menu usingthe WEBSET command.

    This field can be expanded to include up to 1,024 characters ofinformation.

    The message text field contains several formatting options youcan use to control the appearance of the message text portionof your WebReport/i Email message. The feature lets youforce a carriage return into the message text at any point bykeying in a logical-not sign. This is the character that lookslike this: ( ¬ ). On many keyboards, this is the left bracketcharacter, just to the right of the letter P. The exact location

    mailto:[email protected];JOHN;[email protected]

  • 15

    on your keyboard may vary. Check your keyboard mappingfor the exact location. Using this feature, you can separateparagraphs and even insert blank lines.

    You can also choose to include a list of all destination emailaddresses where your email message is being sent. WebReport/i sends each copy of your email separately to eachdestination address. To include this information with youremail, just include the characters "&TOLIST" anywhere in themessage text field. WebReport/i will see this and thensubstitute a list of the destination email addresses includedwith the email send request. When the list is inserted into theemail message text, a line break will be generated followed bythe distribution list in the following format:

    --------------------------------------------------------------------------This message was sent to the following:[email protected]@mycorp.com=======================================

    It is a good idea to place this either at the start of the messagetext or at the very end of the message text. You can alsoinclude this option in the default message text by using option#9 (WEBSET) on the INSTALL menu.

    Note that some mail clients may not like the equal signs asmessage text separators. This can be changed globally on yoursystem. These characters, a 40 character string, are kept in adata area named CONTROL2 starting in position 368. If youhave email clients that have a problem with these, please usethe CHGDTAARA command to change the 40 character stringto some other characters.

    Spool File Action Choose one of the following special values:

    *LEAVE the spool file will be left in the output spoolafter the E-mail is sent.

    *HOLD the spool file will be left in the output spoolafter the E-mail is sent and will be changed toHOLD status.

    *CANCEL the spool file will be deleted from the outputspool after the E-mail is sent.

  • 16

    Additional parameters are needed for this command. When the above parameters have beencompleted, use the Roll function to display the next panel:

    To complete the command, enter these parameters as follows:

    New Output Queue When you use a Spool File Action of *LEAVE (above), youcan optionally tell WebReport/i to place the spool file in adifferent output queue and you can also change the formtype atthe same time. If you choose this option, be sure to specify avalid output queue and the library where it is located.

    Note: When processing a report in *ISP (spool file) format,WebReport/i always defaults to placing the report on holdfollowing the operation. This is done for internal reasons.

    Job Queue Leave this parameter blank if you want to process the report asemail interactively. If you want to spin this process off into asystem job queue, enter the job queue name here. Note, thejob queue must be one that is in a library associated with thelibrary list for your current job.

    Zip output file? Option allows you to compress the output file before it is sent.This option will only work if you have the QSHell and Javaoptions installed in the IBM i/OS on your system. To checkthis, go to the IBM menu LICPGM and run option #10. Verifythese OS options before using this feature.

  • 17

    Options are:

    *NO The file attachment is not compressed.

    *YES The file attachment is compressed in zip formatbefore it is sent.

    When you select the *XLS or *XLX option for Excel spreadsheet file format, the followingadditional parameters will be requested:

    Specify the following parameters to control your spool file conversion to Excel format:

    Exclude line numbers This option can be used to exclude page footer lines. If yourreport does not include any footers, just the default *NONEvalue. To exclude footers, enter the starting and ending linenumbers for the footer lines. If they are on the same line, usethat same value in both parameters.

    CCSID for conversion Specify the CCSID value that you want to associate with thespool file being converted. This parameter only applies to*PDF, *XSL or *XLX conversions.

  • 18

    Choose from the following:

    *SPLF Use the CCSID value associated with the spoolfile.

    *JOB Use the CCSID value associated with thecurrent job.

    *SYSVAL Use the CCSID value associated with thesystem value QCCSID.

    *USER Use the CCSID value associated with the userprofile.

    1-65533 Use the specific CCSID value entered.

    Keep page headings? Use one of these options:

    *FIRST - only keep the headings from the first page*ALL - keep all page headings*NONE - ignore all page headings

    Page heading start line This parameter is only used when your conversion methodrefers to a report model. If the XLSCONV parameter is set to*AUTO, this parameter is ignored.

    Enter the starting line number for the page headings on yourreport.

    Page heading ending line This parameter is only used when your conversion methodrefers to a report model. If the XLSCONV parameter is set to*AUTO, this parameter is ignored.Enter the ending line number for the page headings on yourreport.

    Keep column headings? Use one of these options:

    *FIRST - only keep the column headings from the first page*ALL - keep all column headings*NONE - ignore all column headings

    Column heading start line This parameter is only used when your conversion methodrefers to a report model. If the XLSCONV parameter is set to*AUTO, this parameter is ignored.

    Enter the starting line number for the column headings on yourreport.

    Column heading ending line This parameter is only used when your conversion methodrefers to a report model. If the XLSCONV parameter is set to*AUTO, this parameter is ignored.

    Enter the ending line number for the column headings on yourreport.

  • 19

    Font face Select the font that you want to use for the conversion. Thefollowing are currently supported:

    *ARIAL, *COURIER, *COURIERB, *COURIERO,*COURIERBO, *HELVETICA, *HELVB, *HELVO,*HELVBO, *TIMES, *TIMESB, *TIMESI, *TIMESBI,*SYMBOL, *DINGBATS

    Font size Choose the size that you want to enforce for the selected font.

    XLS conversion method For conversion to XLS format, this parameter lets you selectthe way WebReport/i does the conversion. Choose one of thefollowing options:

    *AUTO - Use WebReport/i's automatic column interpretation. This option is preferred for the first time that you attempt an*XLS or *XLX conversion on a report.

    Model Name - Enter the name of an XLS Report Model thatyou have built using the option from the MASTER menu forthis purpose.

    When you select your output in the *CSV format, several additional parameters are requested asshown here and on the next display panel:

    Enter these parameters as follows:

    Delimiters: (There are 5 elements to the parameter as follows)

  • 20

    Record delimiter This parameter defines the characters to be used to indicate theend of a record in the CSV file.

    *CRLF Carriage return and line feed. Both a carriage return (x'0D')and a line feed.

    *CR Just a carriage return (x'0D') is used.*LF Just a line feed (x'0A') is used.

    String delimiter The character to be used to enclosed character string data.

    *DBLQUOTE A double quote (") is used.

    *SGLQUOTE A single quote (') is used.

    *NONE No delimiter is used. Alphanumeric data is not enclosed byany special character.

    Delimiter-char The delimiter character to use.

    Field delimiter The character to be used to separate fields in the CSV file.

    *COMMA A comma (,) is used.

    *TAB A tab (x'09') is used.

    *BLANK A blank (x'20') is used.

    *SEMICOLON A semicolon (;) is used.

    Delimiter-char The delimiter character to use.

    Column separator The values you select on this parameter control how thespooled file is converted to a delimited ASCII text file (e.g. acomma separated variable file).

    The default for the first element is *SPLF. This tellsWebReport/i to break the spooled file data into columns basedon the way in which the data is split up in the spooled file.

    Where the spooled file is created from an externally describedprinter file this will probably give the best results, since thedata in the spooled file is likely to be organized so that eachnatural or logical item of data appears as a separatelyidentifiable element.

    However, if the spooled file is created from an internallydescribed printer file, or from an application such as IBM’sQuery/i, it is likely that the data in the spooled file will bepresented to WebReport/i as a single, unstructured data blockfor each line of the report. If this is the case then better resultswill probably be achieved by defining a column separatorcharacter to control the splitting of the data in the report.

    The column separator character can be any alphanumericcharacter. Often the best results will be obtained by selecting

  • 21

    *BLANK (blank character) which will split the data in thespooled file every time one or more consecutive blankcharacters occur.

    *SPLF Split the data in the report based on the organization of thedata.

    *BLANK Blank

    character The character to use to force a column split.

    Number of column The number of consecutive column separator characters separator characters required to force a column split.

    Number The number of characters required.

    Exclude pages The EXCLPAGES (Exclude Pages) parameter allows you toidentify pages of the spool that should not be included in theresultant stream file.

    For example, if your spooled file contains header sheets orbatch separator pages dropped using this parameter.

    There are five elements to this parameter, each providing adifferent method of pages from the spooled file.

    At start of spooled file The number of pages to exclude at the beginning of thespooled file. If you specify a number on this parameterelement, then that number of pages will be ignored at the startof the spooled file. If your spooled file contains one or moreunwanted header sheets at the beginning of the spooled file,these can be dropped by specifying the number of pages to bedropped here.

    At end of spooled file The number of pages to exclude at the end of the spooled file.If you specify a number on this parameter element, then thatnumber of pages will be ignored at the end of the spooled file.If your spooled file contains one or more unwanted trailersheets at the end of the spooled file, these can be dropped byspecifying the number of pages to be dropped here.

    At start of each stream file The number of pages to exclude at the beginning of eachstream file created from the spooled file. If your spooled filecontains one or more unwanted header sheets at the beginningof each set of required pages, these can be dropped from thestream file by specifying the number of created from thespooled file. If your spooled file contains one or moreunwanted header sheets at the beginning of each set ofrequired pages, these can be dropped from the stream file byspecifying the number of pages to be dropped here.

    At end of each stream file The number of pages to exclude at the end of each file createdfrom the spooled file. If your spooled file contains one or moreunwanted trailer sheets at the end of each set of required

  • 22

    pages, these can be dropped from the file by specifying thenumber of pages to be dropped here.

    Exclude pages by key A key string identifying pages to be dropped. Every page ofthe spooled file which contains the string specified here willbe omitted from the resultant file(s). For example, if yourspooled file contains batch header sheets, and these contain theword "Batch" on them, they can be excluded from the streamfile by specifying "Batch" as the key string on this parameter.

    Exclude line numbers: The EXCLLINNBR (Exclude line numbers) parameter allowsyou to define lines which should be dropped from the outputCSV or Excel file, for example unwanted headings.

    The group is specified by indicating a starting line and anumber of following lines to be excluded.

    From line number Enter the starting line number or specify the special value*NONE if none are to be excluded.

    Number of lines The number of lines to be excluded.

    Exclude lines by key: The EXCLLINKEY (Exclude lines by key) parameter allowsyou to define lines which should be dropped from the outputCSV or Excel file, for example unwanted sub-headings.

    The group is specified by indicating a key string, which, whenlocated in the spooled file, denotes the start of the group, and anumber of following lines to be excluded.

    Exclude lines containing The key string indicating the start of the group of lines to beexcluded from the output or the special value *NONE if nolines are to be excluded.

    Number of lines The number of lines to be excluded.

    When you specify an Acrobat format (*PDF) output file to be sent, you can also specify additionalsecurity and control parameters that will be prompted as follows:

    If you do not want to specify any of the Acrobat security features, leave the default value of *NO onthe password protect field (the first parameter) and skip to the Additional Margins fields.

    By changing the one of the other values as shown here, you must the specify some or all of theadditional fields below:

    *YES The output PDF file will be encrypted with 40 bit encryption. Thepassword fields and restriction fields will be honored.

    *RESTRICT The output PDF file will be encrypted with 40 bit encryption. Thepassword fields will not be enforced, but the restriction fields will behonored.

  • 23

    *RST128BIT The output PDF file will be encrypted with 128 bit encryption. Thepassword fields will not be enforced, but the restriction fields will behonored.

    *PWD128BIT The output PDF file will be encrypted with 128 bit encryption. Thepassword fields and restriction fields will be honored.

    The following addition security fields are also used when processing PDF files with securityinformation:

    User password This is a case sensitive field of 32 characters. Enter the userpassword you want associated with the converted PDF file.

    Owner password This is a case sensitive field of 32 characters. Enter the ownerpassword you want associated with the converted PDF file.

    Allow printing? If you want to allow printing of the PDF file, change thisparameter to *YES.

    Allow modifications? If you want to allow the PDF file to be modified, change thisparameter to *YES.

  • 24

    Allow copying of text? If you want to allow text to be copied from the PDF file,change this parameter to *YES.

    Allow annotation? If you want to allow annotations to be made to the PDF file,change this parameter to *YES.

    Note: When you specify *YES for the Acrobat password, the Acrobat file is automaticallyencrypted.

  • 25

    WebReport/i also provides page size, page alignment and overlay alignment options that you willsee on the following display:

    Kisco recommends that, initially, you use the default settings for the page size set of parameters. Ifyou find that you are having issues with page size, or if you are sending spool files as fax documentsthrough MetroFax, then you can experiment with different settings. For fax rules, see the separatesection of this manual for specific recommendations.

    Paper size Use one of the following values: *SPLF, *CUSTOM,*A3, *A4, *A5, *B4, *B5, *LETTER, *LEGAL,*EXEC, *LEDGER. Note that customer, exec andledger are not fully available as of this release.

    Orientation Use one of the following values: *SPLF,*LANDSCAPE, *PORTRAIT

    Rotated pages shown unrotated? Choose either *YES or *NO

    Auto-rotation in effect? Choose one of the following values: *NO, *YES,*SPLF, *COR, *PAGESIZE. Note that the pagesizeoption is not implemented as of this release.

  • 26

    Horizontal/Vertical scaling The Scaling options allow for values from 00.01 to99.99 be entered. This will control the scaling process. A value of 0.5 will generate a result that is 1/2 of thedefault size. A value of 1.5 will generate a result thatis 1.5 times larger. You can control the horizontalscaling separately if you need specific effects. In theAutomatic Routing tables for both Email Routing andSystem Routing, you will also find these new controlfields available on the additional PDF parameterscreens.

    You can also control page alignment and AFP overlay alignment from this screen. Some trial anderror will be needed to find the right set of parameters. Most pages and AFP overlays will aligncorrectly without any adjustments. If you find you need adjustments, try the following:

    Overlay left Controls the left margin of the overlay. Specify a number inthe range indicated on the prompt.

    Overlay top Controls the top margin of the overlay. Specify a number inthe range indicated on the prompt.

    Page left Controls the left hand margin for the page.

    Page top Controls the top margin for the page.

    Unit of measure Describes the values used for alignment as either in inches(*INCH), millimeters (*MM) or centimeters (*CC).

    The following additional parameters are also requested for a *PDF process:

    CCSID for conversion Specify the CCSID value that you want to associate with thespool file being converted. This parameter only applied to*PDF conversions. Choose from the following:

    *SPLF Use the CCSID value associated with the spoolfile.

    *JOB Use the CCSID value associated with thecurrent job.

    *SYSVAL Use the CCSID value associated with thesystem value QCCSID.

    *USER Use the CCSID value associated with the userprofile.

    1-65533 Use the specific CCSID value entered.

    Font size for PDF conv For *PDF conversions, this parameter gives you control overthe size of the font used. Choose from the following:

    *CALC Use this default value to let WebReport/i

    calculate a font size based on the attributes of

  • 27

    your print file.

    *SCALE If you find that *CALC does not produce asatisfactory result, try this *SCALE value. Adifferent method will be used to set the fontsize based on different spool file attributes fromyour report.

    4-36 If you want to use a specific font size, code thenumeric value within the range of 4 to 36.

    PDF Font Type Choose one of the following values:

    *MAP WebReport/i will attempt to map the font inyour spool file as closely as possible using PDFfonts available. This is the default value andwill normally produce the desired result.

    *EMBED WebReport/i will embed the selected fontdirectly into the PDF file. When *MAP resultsare unsatisfactory, this option should be tried asit may give better results.

    *CONVERT This is the same as *MAP.

    For specific font faces, use the HELP (F1) key to display a listof those that are available.

    Some customers reported issues to us when using color overlays. The problems are associated withsections of the spool file getting overlaid with areas of the overlay. If you experience this problem,then we recommend that you process the following two commands on your system and then try thePDF conversions again:

    ADDENVVAR ENVVAR(CS_PDF_NON_HPT_OVL_IMG) VALUE(*YES) LEVEL(*SYS)

    ADDENVVAR ENVVAR(CS_PDF_HPT_OVL_IMG) VALUE(*YES) LEVEL(*SYS)

    With this version installed, the above two commands should change the results that you are seeingso that the overlay is handled correctly.

    We specifically do NOT recommend setting these two environment variable unless you have thedocumented issue.

  • 28

    A final screen of options is also available as follows:

    Fill in the parameters as follows:

    Include pages Lets you specify a range of pages to be included in the PDFthat is created for this process. Leaving the default values willsend the entire report.

    Add digital signature? If no digital signature is wanted, leave the default value. Toenter information about using a digital signature, change thevalue to *YES. When you do this, the additional parametersneeded will be prompted. Please refer to the special section ofthis documentation for more details on filling out the digitalsignature values.

    DBCS coded font This parameter gives you control over the font that is selectedwhen a DBCS coded font is to be used.

    Choose one of the following options:

    *SPLF This is the default value. WebReport/idetermines the DBCS font name from the spoolfile attributes.

    *BUILTIN WebReport/i will use its built in conversionfont.

  • 29

    *IGNORE WebReport/i will ignore data that appears to beDBCS and will treat it as SBCS data.

    *NOERROR If the DBCS font cannot be identified,WebReport/i continues processing as if*IGNORE had been specified and no error isissued.

    PDF Form Name If you are using a PDF Form control file for this spool file,enter the name of the form you have created here. If no PDFForm control is being used, leave the default value of *NONEhere. WebReport/i has a separate documentation guideavailable just for PDF Forms implementation.

    PDF to be Added When doing a conversion to PDF format, this parameterallows you to append your own PDF file from the IFS onto theend of the converted spool file. This can be used to addstandard verbage at the end of the report, such as terms andconditions for purchase orders, invoices, etc.

    Choose one of the following options:

    *NONE No additional PDF is to be appended.

    IFS file name Enter the name of the file in the IFS that youwant to add to your conversion. This must bethe full IFS path for the file.

  • 30

    There are some optional parameters for this command that are hidden from the prompt. These arelittle used parameters, but they can be displayed by pressing the F10 key and then scrolling up toview them. They will appear as follows:

    These parameters are defined as follows:

    Recipient Note: This parameter is included to provide compatibility withearlier releases of WebReport/i. It is used when you are usingSMTP destination addresses that are still defined in theWRKDIRE system directory. Kisco does not recommend thisaddressing scheme for new customers just starting withWebReport/i.

    Enter up to twenty pairs for user ids and locations. These mustall be currently active in your system directory. You mayleave these blank if you are using Internet Addresses for yourrecipients. If you are using imbedded email directivestatements in your spool file, you can indicate that by using thespecial value of *INT in the first occurrence of this parameter.

    Refresh Directory? If you have made recent changes to the system directory, youmay want to respond to this with the *YES special value. Specifying *YES will add overhead to the transmission

  • 31

    process and slow down sending your report. This shouldprobably NOT be used in a production environment. To usethe *YES option, you must be enrolled in the system directory.

    Merge Overprint Lines? This option controls how overprint lines in the spool file arehandled by WebReport/i for *TXT and *RTF processing. Choose one of the following values:

    *NO Default value. When overprint lines are found in thespool file, only the first line will be processed. Allother overprint lines will be ignored.

    *YES When overprint lines are found, the contents of eachline will be merged together into a single line.

    Text Page Breaks? Controls whether or not an additional separator line ofhyphens will be inserted in *TXT spool file conversions. Choose one of the following:

    *BREAKS Default value. The line of hyphens willbe inserted at the page break points.

    *NOBREAKS No line of hyphens will be inserted.

    *GENDAT filename prefix If you are using the *GENDAT file naming option, enter a twocharacter code in this field. It will default to ‘AA’.

    Message text CCSID For most processing, the *JOB default value will work. If youwant to use a specific CCSID value for the message text onthis email, enter the specific value. This can be of use whenyou have text in a different language from that in effect foryour job.

    There is one additional parameter available when you roll-up on screen at this point:

    IFS File Attach When sending a report using the EREPORT command, youcan optionally also send any other file currently stored in theIFS. This additional file will be appended to your emailmessage as a second file attachment.

    Choose one of the following options:

    *NONE No additional attachment from the IFS will beincluded.

    IFS file name Enter the name of the file in the IFS that youwant to add to your email message. This mustbe the full IFS path for the file.

    After all parameters have been entered, press ENTER and the spool file will be processed. Eachuser specified as a recipient will receive a copy of the report selected as an E-mail attachment.

    Because of timing problems with earlier versions of IBM i/OS, a delay was added to the email

  • 32

    process in WebReport/i. This delay added 5 seconds to the time needed to email a report. For mostcustomers this is not an issue, but some customers have requested to reduce this delay time. WebReport/i has been changed so that the delay time is now an external variable that is stored in thedata area named CONTROL2 in library WEBREPORT.

    The delay time is found in positions 409-410 of the CONTROL2 data area. If these characters areblank, then the default value of 5 seconds will be enforced. You cannot change this value to zero.

    You can change the delay time variable by using the following command:

    CHGDTAARA DTAARA(WEBREPORT/CONTROL2 (409 2)) VALUE('01')

    This example will set the delay time to 1 second.

    An alternate command format, EREPORTA, is also available. This alternate format has some of theparameters sequenced differently. Several customers report finding this format easier to use fortheir purposes. We suggest that you experiment with its use to find which works best for yourinstallation.

    If you find that you prefer the alternate version, you can make it your default version by running thefollowing two commands on your system:

    RNMOBJ OBJ(WEBREPORT/EREPORT) OBJTYPE(*CMD) NEWOBJ(EREPORTSAV)

    RNMOBJ OBJ(WEBREPORT/EREPORTA) OBJTYPE(*CMD) NEWOBJ(EREPORT)

    When this is done, the alternate form of the command will be in use for all users on your system.

  • 33

    Email Routing Using Addresses in the Spool File

    This feature of WebReport/i lets you place email addresses in your print spool for automatic routingpurposes. Using this feature, you can create a single spool file that contains multiple messages todifferent Email destinations. WebReport/i will process the report and send it to the variousdestinations automatically. Using this feature, you can create reports using Email addresses on yourdatabase files for automatically splitting output reports. It will even let you send segments of thereport for local printing on paper. You can use this method of automatic routing for *PDF, *TXT,*RTF, *XLS and *XLX conversions.

    Note: You cannot split up segments of a page with this feature. The entire contents of a page mustbe destined for your email contact.

    Note: When sending Adobe Acrobat attachments, this feature will only work when the spool file isan *SCS type spool file (ie: character based, non-graphic). If you have a spool file that is using anAFP (IBM’s Advanced Function Printing) overlay, it can be used with an *SCS spool file andWebReport/i will keep the overlay with the output that is processed.

    There are two components to this feature. First, you have to add the destination Email addresses tothe spool file output from your program. This is done by inserting "Email Directive" lines in yourprint spool. The Email Directive lines will NOT be included in the output Email that is sent and areonly used for telling WebReport/i where to send the reports and/or report segments.

    The Email Directive statements must always start in position 1 (or position 2) of the spool file printline. A Directive can contain a single Email address or multiple addresses. You can code a singleDirective at the start of the spool file or place them throughout the spool file.

    A simple Email Directive statement might look as follows:

    #EMAIL("[email protected]")

    If you used this example, the spool file contents starting with the line following the Directivestatement will be sent to the Email address "[email protected]" until another Directive is foundor until the end of the report is found. Note that you must use double quotes exactly as shown inthis example.

    To send a segment of the spool file for local printing, the Email Directive should look as follows”

    #EMAIL(“*OUTQ”)

    When WebReport/i sees this directive, it will route the segment of the spool file to the defaultoutput queue that is specified in the INTOUTQ parameter of the WEBSET command (option #9 onthe INSTALL menu). See the documentation for the WEBSET command for more details.

    If you want to send the report to multiple destinations, then you can code the Directive as follows:

    #EMAIL("[email protected];[email protected]")

    Note the use of a semi-colon to separate the addresses. If you have more Email addresses than willfit on a single line, you can use multiple Directive lines. Note that they MUST be on linesimmediately following the first of the Directive lines. An example of this might look like thefollowing:

  • 34

    #EMAIL("[email protected];[email protected]") #EMAIL("[email protected];[email protected]")

    The Directive line can also be used to specify a variable Email Title value. To implement thisfeature, you need to change the format of the #EMAIL directive that you place in your spool file. This directive is used for sending different segments of a report to unique destination Emailaddresses. You can add the title information by coding an additional parameter on the #EMAILdirective. Here is an example of the format you should use:

    #EMAIL("[email protected]") TITLE("Special Email for Name1")

    In this example, the segment of the report will be sent to the Email address"[email protected]". That Email message will carry the subject line shown in the TITLEparameter. You must be careful to code the parameter exactly as shown, complete with the quotesas shown. Also, the TITLE parameter has to conform to the following rules:

    1. It cannot exceed 50 characters in length.2. If you have multiple #EMAIL directive lines, the TITLE parameter must appear on

    the last of these before the report segment starts.

    The second part of this feature is the method that you use to tell WebReport/i to use the InternalAddresses. If you are using the EREPORT command (or menu option #1 from the MASTERmenu), then you must use the special value '*INT' in the first Internet Address parameter (TOINET). No other Internet Addresses can be coded on the command. This configuration will tellWebReport/i to look for the Email Directive statements in the spool file being sent.

    If you are using Automatic Email Routing, then the automatic routing entry must be set up in asimilar manner. Internet Address # 01 or E-mail Recipient # 01 must be set to the special value'*INT'. No other recipient information can be entered.

  • 35

    Email Routing Based On Report Content

    WebReport/i now includes a feature that customers have been asking for from Kisco. With thisfeature, you can split up a report during Email (EREPORT) processing based on informationcontained within the report. WebReport/i will look in a specific location on each page for a givenvalue (such as customer number, salesman number, etc) and then route that segment of the reportbased on information that you set up for the report. This feature is recommended only to work withreports where all of the content on a report page should be routed to a single destination.

    To use this feature, you will need to create a Report Map that defines the location of the field withinthe report that you are using for breaking the report. Once this is done, then you can create the MapRouting information. In the Map Routing, you will enter the specific codes that can appear on yourreport and how you want each segment of the report processed. Once the Report Map and the MapRouting have been set, then you can start using them on the EREPORT command.

    To tell the email process that you are using a Report Map, just specify the special value "*MAP" inthe email field (TOINET) parameter. This parameter supports up to 20 instances for multipleaddresses. When using the *MAP option, the name of the Report Map that you want to use MUSTappear in the first 10 characters of the second instance of the parameter. As an example, if yourReport Map is named CUSTMAP, then the TOINET parameter must appear as follows:

    TOINET(*MAP CUSTMAP)

    When the email process is set this way, the report will be split based on the report contents.

    You can also use Automatic Email Routing to process reports using the *MAP option. When youcreate the routing entry using option #18 on the MASTER menu, enter the *MAP value for theparameter identified as "Internet Address # 01". Then, on the second detail panel, use the F8 optionto access the Additional Email Addresses screen. In the first 10 characters of the "Internet Address# 02" field, enter the name of the Report Map that you want to use. NOTE: Make sure that youenter the Report Map Name in all capital letters (upper case).

    Restriction: Please note that this process only works when the spool file in question is an *SCStype spool file. Other spool file types will fail. If you have an immediate need to process anon-*SCS spool file type, contact Kisco Information Systems support team.

    Restriction: The current program only supports *PDF, *XLS and *XLX spool file conversionswhen using the *MAP option. It is Kisco's intention to support *TXT and *RTF in a future releaseof the software. If you have a need for this support before it is available, contact Kisco support.

    To build a Report Map, use the new command in the system named MAPCTL. There are noparameters on this command. It will display a list of Report Maps. When you first start it, no Mapswill be shown as follows:

  • 36

    Use the F6 key to create a new map. When you do, the following screen will be shown:

  • 37

    Fill in the parameters as follows:

    Map Name Enter a unique 10 character name that you want to assign to this Report Map.

    Line# Enter the line number on the report where your control value will always befound.

    Col# Enter the column number on the report line where your control value will

    always be found.

    Length Enter the number of characters that gives the length of the control value as itappears on your report.

    Description Enter a description of the value described here.

    When all fields have been entered, press ENTER and the display will return to the list of ReportMaps. Your new Map should now appear.

    Once a Report Map has been created, you MUST now also enter at least one value for comparisonand handling. As soon as you have created your Report Map, place an option #9 next to it and pressENTER. This will cause WebReport/i to generate a default entry for the Report Map in the Report Map Routing table. When the Report Map Routing is displayed, you will see onerecord with a Compare Value of "*DEFAULT". This describes how report segments that are not inthe Routing Table are processed. This record cannot be deleted.

    To create a Map Routing entry, press the F6 key and the following will be displayed:

  • 38

    Fill in the fields as follows:

    Compare Value Enter the EXACT value that you want to compare to the control fieldspecified for this Report Map. All of the characters of the controlfield must be included here starting in the first position of the field.

    Example: If you are using a 9 character customer number, that number mustappear in the first 9 characters of the compare field.

    Notes: If your report prints a number and it uses left hand zero suppression,the leading blanks must be included in this table.

    Internet Addresses These fields can be used for stacked email destination addresses. Thesame rules that apply for the TOINET parameter on the EREPORTcommand apply here. You can code specific email addresses oraddress abbreviations based on the WebReport/i Address Book. The*INT option is NOT supported here. You can use the *OUTQ optionas long as it is the only destination coded.

    You only need to enter information in the first of the two fields. The others are provided for youruse if they are needed for complex routing instructions.

    Once the information has been entered, press ENTER to record it.

    The *DEFAULT entry describes how report segments will processed when no valid compare valueis found. WebReport/i will use a default email address from your WEBSET command setting(option #9 on the INSTALL menu) when initially setting this up, but you may want to change this. We recommend that you check this before you start using your Report Map.

    Some customers may have email addresses already on file in existing database files. You may wantto transfer this information into WebReport/i for Report Map processing. The following is a suggested manual procedure for doing this.

    Example:

    In this example, we will transfer customer numbers and email records from a file namedCUSTOMER in your library named MYLIB into WebReport/i. Your WebReport/i Map will benamed CUSTMAP. In your CUSTOMER database file, the customer number field is named ACCTNO and the email address is named EADDR.

    In this example, the lower case values are those that need to be customized to your specification.

    Step Action 1. First, create your Report Map and then use option 9 to start the Report Map Routing process.

    This will place the required *DEFAULT value record in the Map Routing table.

    2. Exit the Report Map maintenance function and return to the IBM i/OS command line.

    3. Enter the following command to set up your Report Map Routing in the temporary work fileused for this process:

    CPYF FROMFILE(WEBREPORT/MAPCTL2) TOFILE(WEBREPORT/MAPCTL2WK) FROMMBR(custmap) MBROPT(*REPLACE)

  • 39

    4. Start an SQL session from your terminal by running the STRSQL command.

    5. On the SQL command line, run the following 2 SQL statements:

    INSERT INTO WEBREPORT/MAPCTL2WK (MA2VAL, MA2AD1) SELECT acctno, eaddr FROM mylib/customer WHERE EADDR ' '

    UPDATE WEBREPORT/MAPCTL2WK SET MA2NAME = 'custmap ' WHERE MA2NAME = ' ' 6. Exit your SQL session using the F3 function.

    7. Now you can copy the updated work file back in place using the following command:

    CPYF FROMFILE(WEBREPORT/MAPCTL2WK) TOFILE(WEBREPORT/MAPCTL2) TOMBR(custmap) MBROPT(*REPLACE)

    8. Start the MAPCTL command from the command line and then place a 9 next to theCUSTMAP entry. Review the information transferred into WebReport/i to make sure thatyou have picked up the exact information needed.

    9. If your compare value is showing leading zeros but your report has these zeros converted toblanks (suppressed), then the leading zeros on your converted file will need to be removed.

    If you have any questions about the Report Map process, feel free to contact Kisco InformationSystems support.

  • 40

    Send Multiple Reports in a single E-mail

    Some customer may want to process several reports attached to a single E-mail message. This ispossible in WebReport/i using two different methods.

    EREPORTM Command

    First, you can use the special command EREPORTM. This command will let you bundle up to 5different reports into a single email send operation. You can run this command from the IBM i/OScommand line or integrate it into your own CL programs. The command supports full HELP text. To get started with it, just type the command and press the F4 key to prompt it. The followingscreen will be displayed:

    The parameters for this command are the same as for the EREPORT command already described. The difference between the two is that this command allows you to specify multiple spool files to beprocessed. Note that the attachment file name can be set differently for each spool file entered.

    The prompt screen comes up with fields for processing two different reports. To access the fieldsfor the additional reports, just enter a plus sign (‘+’) in the spool file name parameter and pressENTER. The additional fields will be shown.

    Some restrictions, however, do apply to the use of the EREPORTM command as follows:

    1. It does not support *INT processing to obtain destination email addresses from within the

  • 41

    spool files.

    2. It does not support the older TOUSRID fields for specifying destination email addresses. Only internet addresses can be used.

    3. It does not support the *GENDAT option for attachment file naming.

    4. It does not support the *NONE option for the spool file name.

    5. Automatic processing can only be accomplished by integrating the command directly intoyour own CL programs.

    EFILE Command

    The second method is to use the special EFILE command. To use this method, you should convertyour reports into files stored in the IFS. Using this option, you would convert the reports you wantto send into the IFS first, then run the EFILE command to send them all out together. The EFILEcommand supports up to five different IFS file attachments in a single process.

    The EFILE command can be used as a simpler way to send multiple reports in a single email whenused within your own CL programs. Just use the WREPORT command to generate the reports inthe IFS, then code a single EFILE command to send a group of reports together. Use of the EFILEcommand is not limited to reports stored in the IFS; it can be used for any IFS file.

    The EFILE command is only available for use at the present time from the command line or whenimbedded in your own CL programs. When you prompt the EFILE command, you will see thefollowing:

  • 42

    The parameters for the EFILE command and instructions are as follows:

    TOINET Enter as many email addresses as you need. These must conform to thestandard addressing method of "[email protected]".

    You can stack multiple recipient addresses in this field by separating themwith a single semi-colon character (';'). Be sure not to add any blankcharacters when stacking addresses.

    You can also use address abbreviation names in this field. When you use anabbreviation name, WebReport/i will get the final destination email addressfrom the WebReport/i address book.

    There are additional fields available if the first field is filled with addressinformation. A total of 20 fields are available for use.

    TITLE Enter a text title for the report. You can specify up to 64 characters for thetitle.

    This field supports a macro replacement value:

    Using the macro value &DATE-EXPR will cause WebReport/i tosubstitute the date for the expression when it runs.

    MSGTEXT Choose one of the following options:

    Text Enter an optional text message to be included with the Emailthat you are sending. This message will be included in themain body of the email. For improved formatting, you can usethe logical not sign ("¬") to force a new line within yourmessage text. You can also include the macro value"&TOLIST" anywhere within the text to include a list of allreceipients of the email. Use of the "&TOLIST" must bespecified in upper case.

    *DFT A default message will be included in with the Email. Thecontents of the default text is set by the DFTMSGTEXTparameter on the WEBSET command. This is available onthe INSTALL menu in WebReport/i.

    FROMID This parameter identifies the sender for this email message. Choose one ofthe following values:

    *DFT The default value specified by the WEBSET command isused. You can use the WEBSET command from theWebReport/i INSTALL menu. This value is normally setduring installation and configuration of the software.

    *USER The sender's name will be taken from the text associated withthe current user profile. The sender's email address will be setaccording to the WEBSET command default setting.

    Address Book Abbreviation

  • 43

    If a WebReport/i address book abbreviation value is entered,then the sender's name and email address will be used.

    Email AddressThe email address entered here will be used as the sender'semail address. The sender's name will be taken from thesystem default value shown in the WEBSET command.

    TOID This parameter identifies the recipient for this email message. Choose one ofthe following values:

    *DFT The default value specified by the WEBSET command isused. You can use the WEBSET command from theWebReport/i INSTALL menu. This value is normally setduring installation and configuration of the software.

    Name Enter the specific value that you want to use to identify therecipient for this email.

    IFSATTACH Enter up to 5 files stored in the IFS to be sent. At least first file must bespecified. Each file specified must exist on your system or the EFILEcommand will fail. The full IFS path name must be used and is limited to 64characters.

    The following is an optional parameter that can be displayed from the command prompt by selectingthe F10 key:

    MSGTXTCCSD Controls the CCSID character code used when creating the messagetext for your email. Choose one of the following:

    *JOB Default value. The CCSID value for the current job will be used.

    1-65535 - Enter the specific CCSID value that you want to use.

    When you fill in the parameters the way you want and press ENTER (or execute the command inyour CL program), the reports and files in the IFS will be put together into a single email messageand sent out to the recipients coded.

  • 44

    Send Report by Fax

    WebReport/i supports sending spool files by fax using the internet fax service "MetroFax". As ofthis writing, you can establish a MetroFax account for $14.95 per month which will allow you tosend up to 1,000 pages per month for this single fixed fee. After the first 1,000 pages in any month,the charge is $0.03 per page. For many installations, this will end up being cheaper than themonthly cost of an additional phone line and you will not need any special equipment or modems onyour system to support fax transmissions.

    To send spool files by fax, you will need to open an account with MetroFax. Their website forgetting started is found at:

    http://www.metrohispeed.com/

    Choose the plan you want. The plan that is highlighted above is for Individual & Small Businessaccounts.

    When you create your account, you must remember the email address that you are registering with. All outbound fax email messages must have this email address as the sender address.

    Once your account is active, you can start sending spool files by fax. To do this, just use the regularemail feature of WebReport/i. To send by fax, just specify the destination fax number in the emailaddress followed by "@metrofax.com". For example, to send a fax to us at Kisco InformationSystems, you would use the following email address:

    [email protected]

    The "Sender Identifier" on your email message must be the email address that you signed up with. On the EREPORT command, this is parameter FROMID. In the automatic routing setup, it is called"From Identifier".

    The message text field of your transmission will become a cover page for your fax. On theEREPORT command, this is specified as the MSGTEXT parameter. If you do not want any coverpage sent, change this parameter value to *NONE. The cover page will be included in yourMetroFax page count.

    Also, when sending spool files by fax, we recommend that you specify Acrobat (*PDF) format.When you do this for regular reports that are set up as 132 columns wide by 66 lines high, you willneed special page size parameter settings. These are controlled by the page size parameters. Specialpage alignment settings will also be needed.

  • 45

    When using the EREPORT command, use the following settings for page size:

    Paper size . . . . . . . . . . *LETTEROrientation . . . . . . . . . *PORTRAIT Rotated pages shown unrotated? *YES Auto-rotation in effect? . . . *COR

    NOTE: The *PORTRAIT setting sounds wrong, but it is what works.

    Also use the following settings for PDF page margins:

    Page left . . . . . . . . . . -.3Page top . . . . . . . . . . . .2

    If you choose an internet fax service other than MetroFax, you will have to do someexperimentation with these settings to find what works best for you. WebReport/i should work withother internet fax services, but it has only been fully tested with MetroFax. Based on our testing with MetroFax, other documents sent from the spool file like invoices,statements, purchase orders and so on tend to get faxed correctly when the original default valuesare set. Once you find the combination of settings that works best for each situation, we recommendthat you set them up in the automatic routing table so that they are pre-set for all use.

    The MetroFax service can also be used as a destination fax service with incoming faxes beingconverted to email and forwarded to you. Kisco and MetroFax are completely separate companiesand you may, at time, need to contact MetroFax for support separate from what is provided by KiscoInformation Systems. Kisco recommends MetroFax for this application, but does not receive anycompensation from them in