Chapter 4 - SPLTOOL Interactive Commands

Simple. Effective. Affordable. Your trusted IBM Midrange Partner for over 10 years...

Chapter 4 - SPLTOOL Interactive Commands

The SPLTOOL package contains a set of commands that can be used in your applications if you wish to bypass the SPLTOOL front end display. These commands allow you to peform any option unique to SPLTOOL without having to use the front end.

These commands are called "interactive" commands because they require that you enter specific parameters that identify a spooled file uniquely. Wildcards are not allowed with these commands. For more information on batch commands that allow wildcards for parameters, see Chapter 5.

The interactive commands that are available are:

Print Spooled File Range (PRTRNG) - Use this command to create a duplicate of a spooled file. With this command you can specify starting and ending pages to copy, allowing you to create a duplicate with only the pages you need.
Spooled File to Folder (SPL2FLR) - Use this command to copy a spooled file or a range of pages to a folder that exists on your AS/400.
Spooled File to Stream File (SPL2STMF) - Use this command to copy a spooled file or a range of pagesto a directory on your AS/400.
Spooled File to FTP (SPL2FTP) - Use this command to send a spooled file or a range of pages to a remote machine. With this option the target system must be running an FTP server.
Spooled File to Email (SPL2EMAIL) - Use this command if you have installed the SPL2EMAIL product and are on V4R3 or higher and you have email working properly. This command will send an email with the spooled file as an attachment to the recipient of your choice.

Print Spooled File Range (PRTRNG)

                        Print Spooled File Range (PRTRNG)

 Type choices, press Enter.

 Spooled file . . . . . . . . . .   __________    Name
 Job Name . . . . . . . . . . . .   __________    Name, *
   User . . . . . . . . . . . . .     __________  Name
   Number . . . . . . . . . . . .     ______      000000 - 999999
 Spooled file number  . . . . . .   __________    1-9999, *ONLY, *LAST
 From page  . . . . . . . . . . .   ________      1 - 999999, *FIRST, *LAST
 To page  . . . . . . . . . . . .   ________      1 - 999999, *FIRST, *LAST
 Copies . . . . . . . . . . . . .   ________      1 - 999999
 To output queue  . . . . . . . .   __________    Name
   Library  . . . . . . . . . . .     *LIBL_____  Name, *LIBL
 Hold new spooled file  . . . . .   __________    Name
 Save new spooled file  . . . . .   __________    Name




                                                                         Bottom
 F3=Exit   F4=Prompt   F5=Refresh   F12=Cancel   F13=How to use this display
 F24=More keys

Spooled file - Enter the spooled file name the identifies the spooled file.
Job Name - Enter the job name that identifies the spooled file.
User - Enter the user name that identifies the spooled file.
Number - Enter the job number that identifies the spooled file.
Spooled file number - Enter the spooled file number that identifies the spooled file.
From page - Enter the starting page number to copy.
To page - Enter the ending page number to copy.
Copies - Enter the number of copies you wish to make. This parameter changes the Copies parameter of the spooled file generated.
To output queue - Enter the output queue and library where you want the new spooled file to reside.
Hold new spooled file - Enter the hold status for the new spooled file. *SAME will have the same status as the original, *YES and *NO will set the hold attribute of the new spooled file accordingly.
Save new spooled file - Enter the save attribute. *SAME will have the same status as the original, *YES and *NO will set the save attribute of the new spooled file accordingly.

Spooled File to Folder (SPL2FLR)

                        Spooled File To Folder (SPL2FLR)

 Type choices, press Enter.

 Spooled file . . . . . . . . . .   __________    Name
 Job Name . . . . . . . . . . . .   __________    Name, *
   User . . . . . . . . . . . . .     __________  Name
   Number . . . . . . . . . . . .     ______      000000 - 999999
 Spooled file number  . . . . . .   ________      1-9999, *ONLY, *LAST
 From page  . . . . . . . . . . .   ________      1 - 999999, *FIRST, *LAST
 To page  . . . . . . . . . . . .   ________      1 - 999999, *FIRST, *LAST
 PC file name . . . . . . . . . .   ________      Name
 PC file extension  . . . . . . .   ___           Name
 Folder . . . . . . . . . . . . .   ___________________________________________________
___________________________________
 Translate Table  . . . . . . . .   QASCII____    Name
   Library  . . . . . . . . . . .     *LIBL_____  Name, *LIBL, *CURLIB
 HTML Title . . . . . . . . . . .   ___________________________________________________
_______________________________________________________________________________________
___________
 Line selection . . . . . . . . .   ___________________________________________________
_______________________________________________________________________________________
____________________________________________________________...

 F3=Exit   F4=Prompt   F5=Refresh   F12=Cancel   F13=How to use this display
 F24=More keys

Spooled file - Enter the spooled file name the identifies the spooled file.
Job Name - Enter the job name that identifies the spooled file or enter * for the current job.
User - Enter the user name that identifies the spooled file. Leave this field blank if you specified * for the job name.
Number - Enter the job number that identifies the spooled file. Leave this field blank if you specified * for the job name.
Spooled file number - Enter the spooled file number that identifies the spooled file or enter *ONLY to represent the only spooled file with this name or *LAST to represent the last spooled file with this name.
From page - Enter the starting page number to copy or *FIRST to represent the first page of the report.
To page - Enter the ending page number to copy or *LAST to represent the last page of the report.
PC file name - Enter the file name of the new document. The special value &U will be replaced with the current user's id.
PC file extension - Enter the extension of the new document.
Folder - Enter the name of the folder that exists on your AS/400 that you wish the new document to be created in. The folder must exist. To check for the existance of the folder, use the Work with Folders (WRKFLR) command. The special value &U will be replaced with the current user's id.
Translate Table - Enter the library and name of the translation table you wish to use during the conversion to a document.
HTML Title - Enter the title of the document if you are copying the new file to an .htm (web page) extension. This will set the title of the report.
Line Selection - This is used as an array to tell this command which lines of the spooled file to omit. Placeing an "X" in a position will cause the corresponding line to be ommitted from the new file. For example, if position 2 contains a "X", the second line of every page of the spooled file will be ommitted. This is used to remove standard headings from every page of the new document.

Spooled File to Stream File (SPL2STMF)

                     Spooled File To Stream File (SPL2STMF)

 Type choices, press Enter.

 Spooled file . . . . . . . . . .  __________     Name
 Job Name . . . . . . . . . . . .  __________     Name, *
   User . . . . . . . . . . . . .    __________   Name
   Number . . . . . . . . . . . .    ________     000000 - 999999
 Spooled file number  . . . . . .  ________       1-9999, *ONLY, *LAST
 From page  . . . . . . . . . . .  ________       1 - 999999, *FIRST, *LAST
 To page  . . . . . . . . . . . .  ________       1 - 999999, *FIRST, *LAST
 Stream file  . . . . . . . . . .  ____________________________________________________
____
 Directory  . . . . . . . . . . .  ____________________________________________________
_____________________________________
 Create directory . . . . . . . .   *NO_          *YES, *NO
 Public authority for data  . . .   *INDIR        *INDIR, *RWX, *RW, *RX...
 Public authority for object  . .   *INDIR        *INDIR, *NONE, *ALL...
 Replace file . . . . . . . . . .   *NO_          *YES, *NO
 Stream file code page  . . . . .   437_______    1-32767, *STMF, *PCASCII...
 Translate Table  . . . . . . . .   QASCII____    Name
   Library  . . . . . . . . . . .     *LIBL_____  Name, *LIBL, *CURLIB
 HTML Title . . . . . . . . . . .   ___________________________________________________
_______________________________________________________________________________________
___________
 Line selection . . . . . . . . .   ___________________________________________________
_______________________________________________________________________________________
____________________________________________________________...

 F3=Exit   F4=Prompt   F5=Refresh   F12=Cancel   F13=How to use this display
 F24=More keys

Spooled file - Enter the spooled file name the identifies the spooled file.
Job Name - Enter the job name that identifies the spooled file or enter * for the current job.
User - Enter the user name that identifies the spooled file. Leave this field blank if you specified * for the job name.
Number - Enter the job number that identifies the spooled file. Leave this field blank if you specified * for the job name.
Spooled file number - Enter the spooled file number that identifies the spooled file or enter *ONLY to represent the only spooled file with this name or *LAST to represent the last spooled file with this name.
From page - Enter the starting page number to copy or *FIRST to represent the first page of the report.
To page - Enter the ending page number to copy or *LAST to represent the last page of the report.
Stream file - Enter the name of the new file you wish to create. Include the extension. The special value &U will be replaced with the current user's id.
Directory - Enter the name of the directory that resides in your AS/400 IFS that you wish the new document to be created in. If the path does not exist and the Create directory parameter is set to *YES, the path will be created. The special value &U will be replaced with the current user's id.
Create directory - Enter *YES if you want the target directory to be created if it does not exist or *NO if you do not wish to create the directory.
Public authority for data - Enter the public authority for data if a new directory is created.
Public authority for object - Enter the public authority for object if a new directory is created.
Replace File - Enter *YES if you wish to replace the document if it already exists or *NO to not replace the document.
Stream file code page - Enter the code page for the new document.
Translate table - Enter the library and name of the translation table you wish to use during the conversion to a document.
HTML Title - Enter the title of the document if you are copying the new file to an .htm or .html (web page) extension. This will set the title of the report.
Line Selection - This is used as an array to tell this command which lines of the spooled file to omit. Placeing an "X" in a position will cause the corresponding line to be ommitted from the new file. For example, if position 2 contains a "X", the second line of every page of the spooled file will be ommitted. This is used to remove standard headings from every page of the new document.

Spooled File to FTP (SPL2FTP)

                          Spooled File To FTP (SPL2FTP)

 Type choices, press Enter.

 Spooled file . . . . . . . . . .   __________    Name
 Job Name . . . . . . . . . . . .   __________    Name, *
   User . . . . . . . . . . . . .     __________  Name
   Number . . . . . . . . . . . .     ________    000000 - 999999
 Spooled file number  . . . . . .   ________      1-9999, *ONLY, *LAST
 From page  . . . . . . . . . . .   ________      1 - 999999, *FIRST, *LAST
 To page  . . . . . . . . . . . .   ________      1 - 999999, *FIRST, *LAST
 IP address . . . . . . . . . . .   ___________________________________
 User ID  . . . . . . . . . . . .   ___________________________________
 Password . . . . . . . . . . . .   ___________________________________
 Put or Append  . . . . . . . . .   *PUT          *PUT, *APP
 File name  . . . . . . . . . . .   ___________________________________________________
_____
 Directory  . . . . . . . . . . .   ___________________________________________________
________________________________________
 FTP Representaction  . . . . . .   ASCII__________________________
 Spooled file sequence  . . . . .   *ONLY_____    *FIRST, *NEXT, *LAST, *ONLY
 HTML Title . . . . . . . . . . .   ___________________________________________________
_______________________________________________________________________________________
___________
 Line selection . . . . . . . . .   ___________________________________________________
_______________________________________________________________________________________
____________________________________________________________...

 F3=Exit   F4=Prompt   F5=Refresh   F12=Cancel   F13=How to use this display
 F24=More keys

Spooled file - Enter the spooled file name the identifies the spooled file.
Job Name - Enter the job name that identifies the spooled file or enter * for the current job.
User - Enter the user name that identifies the spooled file. Leave this field blank if you specified * for the job name.
Number - Enter the job number that identifies the spooled file. Leave this field blank if you specified * for the job name.
Spooled file number - Enter the spooled file number that identifies the spooled file or enter *ONLY to represent the only spooled file with this name or *LAST to represent the last spooled file with this name.
From page - Enter the starting page number to copy or *FIRST to represent the first page of the report.
To page - Enter the ending page number to copy or *LAST to represent the last page of the report.
IP Address - Enter the IP address of server name (if it is resolvable from your AS/400) of the machine you wish to FTP the spooled file to.
User ID - Enter the User ID required to sign on to the remote FTP server.
Password - Enter the password required to sign on to the remote FTP server.
Put or Append - Enter *PUT to put the file to the remote server. If the file already exists on the target machine, it will be replaced. Enter *APP to append the file to the remote server. If the file already exists, the data will be appended to the file, otherwise the file will be created.
File name - Enter the name of the new file you wish to create. Include the extension. The special value &U will be replaced with the current user's id.
Directory - Enter the name of the directory of the remote machine you wish the new document to be created in. The special value &U will be replaced with the current user's id.
FTP Representation - Enter the FTP representation to use with the file transfer.
Spooled file sequence - This parameter is used to tell SPLTOOL which spooled file in a sequence you are sending. In most cases when using the SPL2FTP command, this parameter should be *ONLY. If you are performing this command on a group of spooled file and you know specifically which spooled file is first and which ist last, the paramters *FIRST, *NEXT, and *LAST may be used. Specify *FIRST for the first spooled file, *LAST for the last spooled file, and *NEXT for any spooled files inbetween the first and last spooled files.
HTML Title - Enter the title of the document if you are copying the new file to an .htm or .html (web page) extension. This will set the title of the report.
Line Selection - This is used as an array to tell this command which lines of the spooled file to omit. Placeing an "X" in a position will cause the corresponding line to be ommitted from the new file. For example, if position 2 contains a "X", the second line of every page of the spooled file will be ommitted. This is used to remove standard headings from every page of the new document.

Spooled File to Email (SPL2EMAIL)

                           Spooled File To E-Mail (SPL2EMAIL)

 Type choices, press Enter.
 Spooled file . . . . . . . . . .   __________    Name
 Job Name . . . . . . . . . . . .   __________    Name, *
   User . . . . . . . . . . . . .     __________  Name
   Number . . . . . . . . . . . .     ______      000000-999999
 Spooled file number  . . . . . .   _______       1 - 9999, *ONLY, *LAST
 From page  . . . . . . . . . . .   _______       1-999999, *FIRST, *LAST
 To page  . . . . . . . . . . . .   _______       1-999999, *FIRST, *LAST
 To Address . . . . . . . . . . .   ___________________________________________
 To Name  . . . . . . . . . . . .   ___________________________________________
 From Address . . . . . . . . . .   ___________________________________________
 From Name  . . . . . . . . . . .   ___________________________________________
 CC Address . . . . . . . . . . .   ___________________________________________
 CC Name  . . . . . . . . . . . .   ___________________________________________
 BCC Address  . . . . . . . . . .   ___________________________________________
 BCC Name   . . . . . . . . . . .   ___________________________________________
 Attachment File Name . . . . . .   ___________________________________________
 Subject  . . . . . . . . . . . .   ___________________________________________
 Message Text . . . . . . . . . .   ___________________________________________
 MDN Address  . . . . . . . . . .   *NONE______________________________________
 MDN NAME . . . . . . . . . . . .   *NONE______________________________________
 Extra Attachment . . . . . . . .   *NONE______________________________________
 Send With Server Type  . . . . .   *IBMSMTP      *MAILTOOL, *IBMSMTP
 Mail Router  . . . . . . . . . .   *NONE
 Use Mail Router  . . . . . . . .   *NO           *NO, *YES, *ONLY
 Importance . . . . . . . . . . .   *NORMAL       *NORMAL, *HIGH, *LOW...
 Recipient Separator  . . . . . .   ','           Character value
 Debug  . . . . . . . . . . . . .   *NO           *YES, *NO
 Debug File Name  . . . . . . . .   'mailtooldebug.txt'________________________
 Stream file code page  . . . . .   437_______    1-32767, *STMF, *PCASCII...
 Translate Table  . . . . . . . .   Q037337850    Name
   Library  . . . . . . . . . . .     *LIBL_____  Name, *LIBL, *CURLIB
 Spooled File Sequence  . . . . .   *ONLY         *FIRST, *NEXT, *LAST, *ONLY
 Mime header code page  . . . . .   819           1-65535
 Body content type  . . . . . . .   'text/plain'_______________________________
 Manufacturer type and model  . .   *WSCST
 WSCST Name . . . . . . . . . . .   QWPTIFFG4     Character value, *NONE
 WSCST Library  . . . . . . . . .   QSYS          Character value, *LIBL
 Page width . . . . . . . . . . .   8.5           Number
 Page length  . . . . . . . . . .   11            Number
 Page rotation  . . . . . . . . .   0             0, 90, 180, 270
 Margin offset  . . . . . . . . .   20            Number
 Left margin offset . . . . . . .   0             Number
 Top margin offset  . . . . . . .   0             Number
 Include blank pages  . . . . . .   *YES          *YES, *NO
 HTML Title . . . . . . . . . . .   ___________________________________________

 F3=Exit   F4=Prompt   F5=Refresh   F12=Cancel   F13=How to use this display
 F24=More keys

Spooled file - Enter the spooled file name the identifies the spooled file.
Job Name - Enter the job name that identifies the spooled file or enter * for the current job.
User - Enter the user name that identifies the spooled file. Leave this field blank if you specified * for the job name.
Number - Enter the job number that identifies the spooled file. Leave this field blank if you specified * for the job name.
Spooled file number - Enter the spooled file number that identifies the spooled file or enter *ONLY to represent the only spooled file with this name or *LAST to represent the last spooled file with this name.
From page - Enter the starting page number to copy or *FIRST to represent the first page of the report.
To page - Enter the ending page number to copy or *LAST to represent the last page of the report.
To Address - Enter the email address of the person you wish to email this spooled file to.
To Name - Enter the name of the person you are emailing this spooled file to.
From Address - Enter the email address of the person sending the email.
From Name - Enter the name of the person sending the email.
CC Address - Enter the email address of a Carbon Copy recipient.
CC Name - Enter the name of the Carbon Copy recipient.
BCC Address - Enter the email address of a Blind Carbon Copy recipient.
BCC Name - Enter the name of the Blind Carbon Copy recipient.
Subject - Enter the text that you wish to appear in the subject line of the email.
Message Text - Enter the test that you wish to appear in the message body of the email. If you want the message text to contain the spooled file information (for .txt or .html only), specify *ATT s the message text. To create a line break in the message text, use the \n character sequence.
MDN Address - Specifies the Message Disposition Notification email address to be used. With some email clients, a receipt will be returned to this email address when the email message is delivered to and read by the recipient. Do keep in mind that this method is not foolproof and can be turned off on the server or client level of the recipient. In some cases it is not even supported. See RFC 2298. The possible values are: *NONE - No MDN is requested *FROM - Use the "From" email address for the MDN address.
MDN Name - Specifies the name to be used with the MDN email address. This parameter will be ignored if *FROM is used for the MDNADDR parameter.
Extra Attachment - Enter the qualified names of any files you would like to attach to the email besides the spooled file.
Send With Server Type - Enter *IBMSMTP to send with the default IBM SMTP Server, or specify *MAILTOOL to send using MAILTOOL Plus! (requires MAILTOOL Plus!)
Mail Router - Specify the IP address or domain name of the mail router to use to send emails when specifying SENDWITH(*MAILTOOL). If no mail router is used, specify *NONE.
Use Mail Router - If specifying a mail router to use, specify *ONLY to use only the mail router, or specify *YES to use the mail router as a backup if none of the host mail servers are reachable. (Note: If you are using a mail router, most of the time you should specify *ONLY).
Importance - Enter the importance of this email. The valid values are *HIGH, *NORMAL, and *LOW.
Recipient Seperator - Enter the seperator to be used with multiple addresses. It is advised to leave this as the default.
Debug - Entering *YES will produce a debug file for the email that is sent.
Debug File Name - Enter the name of the debug file that is produced.
Stream file code page - Enter the code page for the new document.
Translate table - Enter the library and name of the translation table you wish to use during the conversion to a document.
Spooled File Sequence - This field is used by the SPL2EMAILB command. When using the SPL2EMAIL command this should remain as *ONLY
Mime header code page - Specify the code page to use to build the MIME header for the email to be sent. Most of the time you don't have to change this value.
Body content type - Use this field to specify the content type of the email. The default is text/plain, but should the message body be HTML, this field should then be text/html.
WSCST Name - Top Margin Offset - These parameters were added for compatibility with the AFPTOOL command. When using SPL2EMAIL on an AFP spooled file, AFPTOOL will be called to create the file.
Include Blank Pages - Specify *YES to include blank pages, or *NO to omit blank pages from the resulting file.
HTML Title - Enter the title of the document if you are copying the new file to an .htm or .html (web page) extension. This will set the title of the report.

<<Previous | Next>>

© Copyright 1995-2008 BVS/Tools
Powered by the eRPG SDK