Merge Form Description (MRGFORMD)
| Where allowed to run: All environments (*ALL) Threadsafe: No |
Parameters Examples Error messages |
The Merge Form Description (MRGFORMD) command merges a spooled output file with a database file containing a form description, which is designed with the Start Advanced Printer Function (STRAPF) command. The output can be spooled for later printing, or can be directed immediately to a printer.
The Merge Form Description (MRGFORMD) command is part of the IBM Application Development Tools Program, 5761-WDS. For more information on the advanced printer function (APF) tool, refer to the Advanced Printer Function Guide, SC09-1361.
Note: Do not precede an entry with an asterisk unless that entry is a "special value" that is shown (on the display itself or in the help information) with an asterisk.
Error messages for MRGFORMD
*ESCAPE Messages
- APF5101
- Not able to open printer file &1.
- APF5102
- Error occurred accessing spooled file.
- APF5104
- Form description not available.
- APF5105
- Form description not valid.
- APF5106
- Not authorized to perform requested function.
- APF5107
- Error occurred on device &3.
- APF5121
- File &1 in &2 not correct for APF Utility.
- APF9901
- Error in APF utility.
- APF9910
- Not able to complete display file I/O operation.
- APF9911
- Not able to complete data base file I/O operation.
- APF9912
- Not able to open advanced printer function file.
| Top |
Parameters
| Keyword | Description | Choices | Notes |
|---|---|---|---|
| FORMD | Form description | Name | Required, Positional 1 |
| FILE | File | Qualified object name | Required, Positional 2 |
| Qualifier 1: File | Name | ||
| Qualifier 2: Library | Name, *LIBL, *CURLIB | ||
| SPLF | Spool file | Name, *NONE | Optional |
| JOB | Job name | Single values: * Other values: Qualified job name |
Optional |
| Qualifier 1: Job name | Name | ||
| Qualifier 2: User | Name | ||
| Qualifier 3: Number | 000000-999999 | ||
| SPLNBR | Spooled file number | 1-999999, *ONLY, *LAST | Optional |
| COPIES | Copies | 1-255, *FILE | Optional |
| DEV | Device | Name, *FILE, *JOB, *SYSVAL | Optional |
| SPOOL | Spool the data | *YES, *NO, *FILE | Optional |
| OUTQ | Output queue | Single values: *FILE, *JOB, *DEV Other values: Qualified object name |
Optional |
| Qualifier 1: Output queue | Name | ||
| Qualifier 2: Library | Name, *LIBL, *CURLIB | ||
| FORMTYPE | Form type | Character value, *FILE, *STD | Optional |
| OUTSPLF | Output spool file | Name, *FRMD, ' ' | Optional |
| SCHEDULE | Spooled output schedule | *FILE, *IMMED, *JOBEND, *FILEEND | Optional |
| JOBD | Job description | Single values: *NONE Other values: Qualified object name |
Optional |
| Qualifier 1: Job description | Name, QBATCH | ||
| Qualifier 2: Library | Name, *LIBL, *CURLIB |
| Top |
Form description (FORMD)
Specifies the name of the form description to be used to print a form or to be used in the merge operation.
This is a required parameter.
| Top |
File (FILE)
Specifies the name and library of the file that contains the form description.
This is a required parameter.
The possible library values are:
- *LIBL
- The library list is used to find the file.
- *CURLIB
- The current library for the job is used to find the file. If no current library entry exists in the library list, QGPL is used.
- library-name
- Specify the library in which the file will be located.
| Top |
Spool file (SPLF)
Specifies name of the spooled output file that contains the data to be merged with the form description.
The possible values are:
- *NONE
- No spooled output file is to be specified.
- spool-file-name
- Specify the name of the spooled output file.
| Top |
Job name (JOB)
Specifies the name of the job that contains the spooled output file to be merged with the form description.
The possible values are:
- *
- Specifies that the current job contains the spooled file.
- job name
- Specify the name of the job that created the spooled file to be merged. If no job name is given, all jobs currently in the system are searched for the simple job name.
- user
- The user name identifies the user profile under which the job is run.
- number
- The system assigned job number.
| Top |
Spooled file number (SPLNBR)
Specifies the number of the spooled output file to be merged with the form description.
The possible values are:
- *LAST
- Specifies that the last spooled file with the specified name is to be merged with the forms description.
- *ONLY
- Specifies that only one spooled file has the name specified on the Spool file prompt (SPLF parameter).
- spooled-file-number
- Enter the number of the spooled output file to be merged with the form description.
| Top |
Copies (COPIES)
Specifies the number of copies of the merged spooled output file that are to be printed.
The possible values are:
- *FILE
- The number of copies to print is to be taken from the COPIES value specified for the printer device file (QPAPFPRT).
- number-of-copies
- Enter the number of copies of the merged spooled output file to be printed.
| Top |
Device (DEV)
Specifies the name of the printer device to be used to print the form or merged output.
The possible values are:
- *FILE
- The device used as the printer is to be the same as that specified in the DEV parameter in the printer device file (QPAPFPRT).
- *SYSVAL
- The device used as the printer is specified through system value QPRTDEV.
- *JOB
- The device used as the printer is specified through the job's device file.
- device-name
- Specify the name of the printer device to be used to print the form or merged output.
| Top |
Spool the data (SPOOL)
Specifies whether or not the data is to be spooled.
The possible values are:
- *FILE
- The spooled file attribute is to be the same as that used in the printer device file (QPAPFPRT).
- *YES
- The data is to be spooled.
- *NO
- The data is not to be spooled.
| Top |
Output queue (OUTQ)
Specifies the output queue on which the merged spooled output file is to be placed.
The possible values are:
- *FILE
- The output queue name is to be the same as that specified in the printer device file (QPAPFPRT).
- *DEV
- Use the default output queue value associated with the printer specified on the Device prompt (DEV parameter).
- *JOB
- Use the output queue specified in the job description associated with the job for the spooled output.
- output-queue-name
- Enter the name and library of the output queue that is to contain the spooled database output file. The possible library name values are:
- *LIBL
- The library list is used to find the output queue.
- *CURLIB
- The current library for the job is used to find the output queue. If no current library entry exists in the library list, QGPL is used.
- library-name
- Specify the library in which the output queue will be located.
| Top |
Form type (FORMTYPE)
Specifies the type of form on which to print the merged spooled output file.
The possible values are:
- *FILE
- The merged spooled output file is to be printed on the form type specified in the printer device file (QPAPFPRT).
- *STD
- The merged spooled output file is to be printed on the standard form type used at your installation.
- form-type
- Enter the name of the form type on which the spooled output file is to be printed.
| Top |
Output spool file (OUTSPLF)
Specifies the name of the the merged spooled output file on the output queue.
The possible values are:
- *FRMD
- The forms description name is to be used as the name of the the merged spooled output file on the output queue.
- output-spool-file-name
- Enter the name (10 characters maximum) of the merged spooled output file on the output queue.
| Top |
Spooled output schedule (SCHEDULE)
Specifies when the merged spooled output file is to be made available to a spool writer.
The possible values are:
- *FILE
- The merged spooled output file is to be made available to a spool writer as specified on the Spooled output schedule prompt (SCHEDULE parameter). in the printer device file (QPAPFPRT).
- *IMMED
- The merged spooled output file is to be made available to a spool writer immediately.
- *JOBEND
- The merged spooled output file is to be made available to a spool writer when the current job finishes.
- *FILEEND
- The merged spooled output file is to be made available to a spool writer when the end of the current file is reached.
| Top |
Job description (JOBD)
Specifies the name of the job description to be used to submit the job.
The possible values are:
- *NONE
- The printing is to be done under the current job description.
- job-description-name
- Specify the name and library of the job description to be used to submit the job. The possible library name values are:
- *LIBL
- The library list is used to locate the job description.
- *CURLIB
- The current library for the job is used to find the job description. If no current library entry exists in the library list, QGPL is used.
- library-name
- Specify the library in which the job description will be located.
| Top |
Examples
None| Top |
Error messages
*ESCAPE Messages
- APF5101
- Not able to open printer file &1.
- APF5102
- Error occurred accessing spooled file.
- APF5104
- Form description not available.
- APF5105
- Form description not valid.
- APF5106
- Not authorized to perform requested function.
- APF5107
- Error occurred on device &3.
- APF5121
- File &1 in &2 not correct for APF Utility.
- APF9901
- Error in APF utility.
- APF9910
- Not able to complete display file I/O operation.
- APF9911
- Not able to complete data base file I/O operation.
- APF9912
- Not able to open advanced printer function file.
| Top |