Document Handling Exit Program


  Required Parameter Group:

1 Document name Input Char(12)
2 Folder name Input Char(63)
3 Document type Input Binary(4)
4 Function Input Char(26)
5 Function-specific information Input Char(*)
6 Exit processing indicator Output Char(4)

  QSYSINC Member Name: EOGDOCH

The Document Handling program allows other applications to be called in place of or in addition to the OfficeVision word processor. Requests are sent to the exit program. The exit program can choose to process the request or return it to the OfficeVision program for processing.

OfficeVision application enabler support assists users in integrating other office applications into OfficeVision. This is accomplished by creating command interfaces that define the applications to OfficeVision in terms of document types. Applications created this way can support the following functions:

Table 1. APIs Used to Register User Exit Applications

Function API Used for Registration Exit Point Name and Exit Point Format Name
ADDRESSING Add Exit Program API QIBM_QOE_OV_USR_SND, DOCI0900
ADDRCANCEL Add Exit Program API QIBM_QOE_OV_USR_SND, DOCI0900
CREATE QOGCHGOE  
EDIT QOGCHGOE  
FILLFORM QOGCHGOE  
MAILEDIT QOGCHGOE  
MAILVIEW QOGCHGOE  
MAILFWD QOGCHGOE  
MAILREPLY QOGCHGOE  
MERGE QOGCHGOE  
MERGEOPTS QOGCHGOE  
PAGINATE QOGCHGOE  
PRINT QOGCHGOE  
PRINTOPTS QOGCHGOE  
SEND Add Exit Program API QIBM_QOE_OV_USR_SND, DOCI0900
SPELLCHECK QOGCHGOE  
VIEW QOGCHGOE  
Note: For performance improvements, a local copy of the API information is cached on the first usage by a job. The cached API information is then available for reuse by the executing job. (For example, when a job needs information about a registered user exit program, the information is cached.) Therefore, the changes to the API may not take effect until after the jobs with the cached information are terminated. This means that a user may need to sign off then sign on again before the API changes become effective.

The sign off process is an example of a job termination. The sign on process starts a new job.


Authorities and Locks

None.


Required Parameter Group

Document name
INPUT; CHAR(12)

The name of the document on which the function is performed.

Folder name
INPUT; CHAR(63)

The folder in which the document is located.

Document type
INPUT; BINARY(4)

The DIA document type ID. You can display a list of document types defined with the Work with Document Types (WRKDOCTYP) command. The value must be from 1 to 65535.

Function
INPUT; CHAR(26)

The first 10 characters is the type of operation that the user is requesting for this document. The next 16 characters contain the address of the current work on behalf of user. If there is no work on behalf of user, it will contain spaces.

Refer to the DOCI0100 Format for print function requests.

Refer to the DOCI0200 Format for merge function requests.

Refer to the DOCI0300 Format for spell function requests.

Refer to the DOCI0400 Format for mail function requests.

Refer to the DOCI0500 Format for edit function requests.

Refer to the DOCI0600 Format for create function requests.

Refer to the DOCI0700 Format for fill form function requests.

Refer to the DOCI0800 Format for mail view function requests.

Refer to the DOCI0900 Format for send, addressing, and cancel user application addressing function requests.

Function-specific information
INPUT; CHAR(*)

Additional input that varies by function. See Table 2 for more detailed information.

Note: Function-specific information that is not specified and for which there is no value stored in the document will be passed to the exit program as blanks.

Exit processing indicator
OUTPUT; CHAR(4)

The additional processing that the IBM programs should perform on return from the document handling program. Any code returned, when the function requested does not support it, will be treated as a return code of 0000.

0000 No additional processing required for this request. (Processed like the enter key from the exit.)
0001 Request has been processed, and the user requested to return. The IBM programs process as if F12 were pressed.
0002 Request has been processed, and the user requested to return. The IBM programs process as if F3 were pressed.
0007 Request OfficeVision to delete the document from the mail log (only valid on VIEWMAIL requests).
0008 Request has been processed and the user requested that the item be sent. Only the MailEdit, MailForward, MailReply, Addressing, and Addcancel functions are valid.
0010 The OfficeVision program will process the requester as if the user exit had not been called.
  • For the user application send exit program (ADDRESSING, ADDRCANCEL, and SEND functions), additional processing will occur.

    • If a higher numbered registered user exit program has been defined, that exit program will be called to process the request as if the previous user exit program had not been called.

    • If 0010 is returned from the highest numbered registered exit program, OfficeVision will treat the request as an exit processing indicator of 0000.

  • Considerations for a mail document:

    When working with a mail document, a copy of the original mail document is made. This is done to preserve the integrity of the original mailed document. This copied document is the document that is passed to the application user exit program.

    If a user exit program decides to use the 0010 exit processing indicator on exit (that is, let OfficeVision handle this document), then the application enabler will check to see if a higher numbered user exit program is registered. If so, this second user exit program will get passed to the copied document (this is the copied document that the first user exit program had access to and had the opportunity to modify or transform the data stream content).

    Now if the second user exit program decides to use the 0010 exit processing indicator on exit (and this is the highest number user exit program), the application enabler will return to mail with the request to let OfficeVision process the document.

    It is the responsibility of the user exit programs to maintain the integrity of the copied document. It is possible that one of the user exit programs may have modified the document before the user exit program returns (for example, the user exit program had the opportunity to modify any part of the document or perhaps it may have transformed it to another data stream content).

    The customer installation is responsible for maintaining the integrity of this copied document. If it is important that the exact document is kept upon return from the user exit program, perhaps the user exit program must make a copy before it calls the application program to process the document. It is the responsibility of the user exit program to handle deleting the copied document that it created.
0011 User is requesting that the document be filed locally. If any function other than MailView is used, it is treated as a 0000 return.
0012 User is requesting that the document be filed remotely. If any function other than MailView is used, it is treated as a 0000 return.
0013 User is requesting that the document be forwarded. If any function other than MailView is used, it is treated as a 0000 return.
0014 User is requesting a reply to the document. If any function other than MailView is used, it is treated as a 0000 return.

Table 2 shows when the exit program will be called for each of the document functions.

Table 2. Document Handling Function Requests

Function Description Where Called From
'ADDRESSING' User application addressing(DOCI0900 format)
  • Send Note display; F15

  • Send Document display; F15

  • Send Form display; F15

  • Forward a Mail Item display; F15

  • Reply to a Mail Item display; F15

  • SNDDOC command; F15
'ADDRCANCEL' Cancel user application addressing (DOCI0900 format)
  • Send Note display; F12; F3

  • Send Document display; F12; F3

  • Send Form display; F12; F3

  • Forward a Mail Item display; F12; F3

  • Reply to a Mail Item display; F12; F3

  • SNDDOC command; F12; F3
'CREATE' Create document (DOCI0600 format)
  • CRTDOC command

  • Work with Documents in Folders display; option 1

Note: The exit program is called after the Enter key or F10 is pressed on the Create Document Details display, when details are used.
'VIEW' View document (No function specific format information)
  • DSPDOC command

  • MERGE request with DSPOPT(*VIEW)

  • Work with Documents in Folders display; option 5

  • Work with Documents in a List display; option 5
'EDIT' Edit document and revise a copy of a mail item (DOCI0500 format)
  • EDTDOC command

  • MERGE request with DSPOPT(*EDIT)

  • Work with Documents in Folders display; option 2

  • Work with Documents in a List display; option 2

  • Work with Mail display; option 2
'FILLFORM' Fill Form Document (complete a form using the fill form editor of OfficeVision for AS/400) (DOCI0700 format)
  • FILLFORM command

  • MRGDOC command; DSPOPT is *FILLFORM

  • Work with Documents in a List display; option 15

Note: The exit program is called after the Enter key or F10 is pressed on the Create Document Details display, when details are used.
'MAILVIEW' View mail item (DOCI0800 format)
  • Work with Mail display; option 5
'MAILEDIT' Create a note (DOCI0400 format)
  • OfficeVision main menu; option 4

Note: The exit program is called after F6 (Type Note) is pressed on the Send Note display.
'MAILFWD' Forward a note (DOCI0400 format)
  • Work with Mail display; option 10

Note: The exit program is called after F6 (Type Note) is pressed on the Forward Mail display.
'MAILREPLY' Reply to a note (DOCI0400 format)
  • Work with Mail display; option 11

Note: The exit program is called after F6 (Type Note) is pressed on the Reply to Mail display.
'MERGE' Merge document (DOCI0200 format)
  • MRGDOC command; display merge options is *NO
'MERGEOPTS' Merge document with options (DOCI0200 format)
  • MRGDOC command; display merge options is *YES
'PRINT' Print request (DOCI0100 format)
  • PRTDOC command; display print options is *NO

  • Work with Documents in Folders display; option 6

  • Work with Documents in a List display; option 6

  • Work with Mail display; option 6
'PRINTOPTS' Print with options (DOCI0100 format)
  • PRTDOC command; Display print options is *YES

  • Work with Documents in Folders display; option 9

  • Work with Documents in a List display; option 9

  • Work with Mail display; option 9
'PAGINATE' Paginate document (DOCI0100 format)
  • PAGDOC command

  • Work with Documents in Folders display; option 13
'SEND' User application send (DOCI0900 format) If F15 processing was previously preformed:
  • Send Note display; F10

  • Send Document display; F10

  • Send Form display; F10

  • Forward a Mail Item display; F10

  • Reply to a Mail Item display; F10

  • SNDDOC command; F10

  • F10 or F11 from an edit session
'SPELLCHECK' Check the spelling accuracy or grade level of a document (DOCI0300 format)
  • CHKDOC command

  • Work with Documents in Folders display; option 11


DOCI0100 Format

This is the function-specific information for PRINT and PRINTOPTS requests. This format is filled out the same as it would have looked if the OfficeVision program were to process the request. This format merges the parameters specified on the PRTDOC command with the print options record. The Field column describes the associated PRTDOC parameter for each format.

The Field Descriptions have more detailed information about the fields for this format.

Offset Type Field
Dec Hex
0 0 CHAR(2) Number of copies to print
2 2 CHAR(1) Output device
3 3 CHAR(10) Printer device name
13 D CHAR(10) Output queue name
23 17 CHAR(10) Output queue library name
33 21 CHAR(10) Output file name
43 2B CHAR(10) Form type
53 35 CHAR(10) Printer file name
63 3F CHAR(10) Printer file library name
73 49 CHAR(10) Device file name
83 53 CHAR(10) Device library name
93 5D CHAR(10) Device member name
103 67 CHAR(1) Delay printing
104 68 CHAR(1) Draft spacing
105 69 CHAR(1) Print line numbers
106 6A CHAR(1) Resolve instructions
107 6B CHAR(1) Large print
108 6C BINARY(4) Graphic character set
112 70 BINARY(4) Code page
116 74 CHAR(1) Print separator page
117 75 CHAR(1) Adjust line endings
118 76 CHAR(1) Adjust page endings
119 77 CHAR(1) Allow widow lines
120 78 CHAR(2) Additional spaces to left
122 7A CHAR(1) Print change symbols
123 7B CHAR(5) Change symbols to print
128 80 CHAR(1) Print quality
129 81 CHAR(1) Place on job queue
130 82 CHAR(1) Send completion message
131 83 CHAR(10) Job description name
141 8D CHAR(10) Job description library name
151 97 CHAR(1) Cancel on error
152 98 CHAR(1) Print error log
153 99 CHAR(10) Error log form type
163 A3 CHAR(1) Clear error log after printing
164 A4 CHAR(1) Save resolved output
165 A5 CHAR(12) Resolved output document
177 B1 CHAR(63) Resolved output folder
240 F0 CHAR(1) Multiple line report
241 F1 CHAR(1) Print on both sides
242 F2 CHAR(1) Automatic page binding
243 F3 CHAR(1) Automatically shift margins to avoid truncating text
244 F4 CHAR(1) Renumber system page numbers
245 F5 CHAR(7) Print from page 1
252 FC CHAR(8) Print to page 1
260 104 CHAR(7) Print from page 2
267 10B CHAR(8) Print to page 2
275 113 CHAR(7) Print from page 3
282 11A CHAR(8) Print to page 3
290 122 CHAR(7) Print from page 4
297 129 CHAR(8) Print to page 4
305 131 CHAR(7) Print from page 5
312 138 CHAR(8) Print to page 5
320 140 CHAR(7) Print from page 6
327 147 CHAR(8) Print to page 6
335 14F CHAR(7) Print from page 7
342 156 CHAR(8) Print to page 7
350 15E CHAR(1) Document is a label document
351 15F CHAR(2) Number of labels
353 161 CHAR(3) Width of labels
356 164 CHAR(1) Sheet-feed labels
357 165 CHAR(2) Number of rows per sheet
359 167 CHAR(1) Merge type
360 168 CHAR(10) Query name
370 172 CHAR(10) Query library name
380 17C CHAR(12) Data document name
392 188 CHAR(63) Data folder name
455 1C7 CHAR(10) Data file name
465 1D1 CHAR(10) Data file library name
475 1DB CHAR(10) Data file member name


DOCI0200 Format

This is the structure that is used by this exit program when the function is for merge or merge with options. Note that the single-record merge is not supported.

The merge situations where the user specified DSPOPT(*VIEW) or DSPOPT(*EDIT) results in the exit program being called twice, once for the merge and then once for the subsequent view or edit. The Field column describes the associated MRGDOC parameter for each field.

The Field Descriptions have more detailed information about the fields for this format.

Offset Type Field
Dec Hex
0 0 CHAR(12) To document name
12 C CHAR(63) To folder name
75 4B CHAR(1) Replace document
76 4C CHAR(1) Place on job queue
77 4D CHAR(1) Send completion message
78 4E CHAR(10) Job description name
88 58 CHAR(10) Job description library name
98 62 CHAR(1) Merge type
99 63 CHAR(10) Query name
109 6D CHAR(10) Query library name
119 77 CHAR(12) Data document name
131 83 CHAR(63) Data folder name
194 C2 CHAR(10) Data file name
204 CC CHAR(10) Data file library name
214 D6 CHAR(10) Data file member name
224 E0 CHAR(1) Adjustment option
225 E1 CHAR(1) Multiple line report
226 E2 CHAR(1) Collect footnotes
227 E3 CHAR(258) Reserved


DOCI0300 Format

The Field Descriptions explain the values to use for spell function requests.

Offset Type Field
Dec Hex
0 0 CHAR(1) Type of check
1 1 CHAR(7) Beginning page number
8 8 CHAR(7) Ending page number
15 F CHAR(470) Reserved


DOCI0400 Format

The Field Descriptions explain the values to use for mail function requests.

Offset Type Field
Dec Hex
0 0 CHAR(12) Mail reference document name
12 C CHAR(63) Mail reference folder name
75 4B CHAR(1) Attach mail reference
76 4C CHAR(1) Same note
77 4D CHAR(408) Reserved


DOCI0500 Format

The Field Descriptions explain the values to use for edit function requests.

Offset Type Field
Dec Hex
0 0 CHAR(1) Show exit display
1 1 CHAR(484) Reserved


DOCI0600 Format

The Field Descriptions explain the values to use for create function requests.

Offset Type Field
Dec Hex
0 0 CHAR(1) Display exit display
1 1 CHAR(1) Display document details display
2 2 CHAR(1) Edit document
3 3 CHAR(482) Reserved


DOCI0700 Format

The Field Descriptions explain the values to use for fill form function requests.

Offset Type Field
Dec Hex
0 0 CHAR(12) Shell form
12 C CHAR(63) Shell folder
75 4B CHAR(12) Save form
87 57 CHAR(63) Save folder
150 96 CHAR(1) Replace form
151 97 CHAR(1) Display status
152 98 CHAR(1) Display exit
153 99 CHAR(1) Allow refresh
154 9A CHAR(10) Dump data file
164 A4 CHAR(10) File library name
174 AE CHAR(10) File member name
184 B8 CHAR(1) Replace or add
185 B9 CHAR(1) Output data on exit
186 BA CHAR(299) Reserved


DOCI0800 Format

The Field Descriptions explain the values to use for mail view function requests.

Offset Type Field
Dec Hex
0 0 CHAR(8) User ID (DEN)
8 8 CHAR(8) User address (DGN)
16 10 CHAR(22) Distribution ID
38 26 CHAR(447) Reserved


DOCI0900 Format

The Field Descriptions explain the values to use for send and addressing function requests.

Offset Type Field
Dec Hex
0 0 BINARY(4) Size of format
4 4 BINARY(4) Offset to recipient list
8 8 BINARY(4) Number of addressees
12 C BINARY(4) Number of copy list recipients
16 10 BINARY(4) Number of blind copy list recipients
20 14 CHAR(1) Confirm on delivery
21 15 CHAR(1) Log outgoing mail status
22 16 CHAR(1) Sensitivity
23 17 CHAR(1) Grade of delivery
24 18 CHAR(1) Disclose recipients
25 19 CHAR(1) Importance
26 1A CHAR(1) Allow alternate recipient
27 1B CHAR(1) Allow X.400 conversion
28 1C CHAR(1) Reply requested
29 1D CHAR(7) Reply requested date
36 24 CHAR(6) Reply requested time
42 2A CHAR(1) Function
43 2B CHAR(60) Subject
103 67 BINARY(4) Subject character set
107 6B BINARY(4) Subject code page
111 6F CHAR(60) Reference
171 AB BINARY(4) Reference character set
175 AF BINARY(4) Reference code page
179 B3 BINARY(4) Memo slip character set
183 B7 BINARY(4) Memo slip code page
187 BB CHAR(30) Action item text
217 D9 CHAR(202) User's memo slip text
419 1A3 CHAR(13) Reserved
Note: The following fields repeat as required.
    CHAR(8) User ID (DEN)
    CHAR(8) User address (DGN)

Notes:

  1. The user ID and user address fields are in the order of addressee list, copy list, and blind copy list. The number of users in an addressee list, a copy list, or a blind copy list do not affect the order.

  2. All character fields are left-aligned and padded by blanks unless otherwise noted.


Field Descriptions

Action item text. The actual text of the action item. As shipped, they are:

Additional spaces to left. The number of spaces added to the left margin in your printed document. If the document is not printed on both sides of the paper, this is useful when you want to bind your document. Valid values are 0 through 99.

Adjust line endings. The value Y (yes) adjusts line endings in the printed document. The lines are adjusted according to what is specified on the Line Spacing/Justification Options display. This is useful when you print a document that has data merged into it, has instructions, has display attributes that do not print as spaces, or uses a proportionally spaced font.

The value N (no) means you do not want to adjust the line endings in the printed document.

Adjust page endings. The value Y (yes) adjusts page endings in the printed document. The pages are determined by what is specified for the First typing line and Last typing line prompts on the Page Layout/Paper Options display.

The value N (no) means you do not want to adjust the page endings in the printed document.

Adjustment option. The values indicate the adjustment option you want to use.

1 None
2 Lines (Adjusts line endings in the printed document.)
3 Pages and lines (Adjusts page endings and lines in the printed document.)

Allow alternate recipient. Whether the originator will allow applications to forward or delegate the mail to some alternate recipient.

0 No
1 Yes

Allow refresh. Whether the form refresh will be allowed from within the editor. The value 1 (yes) means the form refresh option will be allowed. The value 0 (no) means the refresh option will not be allowed.

Allow widow lines. The value Y (yes) means the page endings or column endings are determined by the exact number of lines per page as specified on the Page Layout/Paper Options display. Also, use Y (yes) for the Adjust page endings prompt. When you allow widows, a single line from a paragraph could be separated from the rest of the paragraph.

The value N (no) means you do not want to have page endings or column endings determined by the exact number of lines.

Allow X.400 conversion. Whether the originator will allow applications to make conversions to the distribution.

0 No
1 Yes

Attach mail reference. Whether to concatenate the original mail item with the forward or reply operation. For MAILREPLY, this is entered by the user on the Reply to Mail display. For MAILFWD, this will always be set to a value of yes. The values are yes or no.

Automatic page binding. You can choose to adjust margins for page binding, which is a way to print pages and adjust margins for the even pages so that they will line up with the odd pages when printing on both sides. The values are yes or no.

Automatically shift margins to avoid truncating text. You can automatically shift the margin so that as much text as possible is printed if the margin exceeds the paper edge. The values are yes or no.

Beginning page number. A number from 1.0 through 9999.99 or *FIRST or *LAST to specify the page on which you want spell checking to start.

Cancel on error. The value Y (yes) means you want the document to stop printing if an error is detected during printing. The error is listed in the error log with an error message stating that the job is canceled.

The value N (no) means you want the document to print even if an error is detected during printing.

Change symbols to print. Different revision symbols result in a document when the revision symbol is changed. If your document contains more than one revision symbol character, and you do not select which revision symbol characters you want to print, all revision symbol characters specified in your document will print.

Clear error log after printing. The value Y (yes) means you want previous errors removed from the existing error log page before new ones are added. This is useful if you want the error log to contain only the errors that occurred during one printing of the document.

The value N (no) means you want your errors added to the end of the existing error log page. This is useful if you want to keep a history of all the times your document printed.

Code page. A particular assignment of hexadecimal identifiers to graphic characters. If you want to specify a code page, type the graphic character-set and code-page combination. A code page is a particular assignment of hexadecimal identifiers to graphic characters. When both the graphic character-set ID and code-page ID are typed, they must be separated by a hyphen.

Collect footnotes. The value Y (yes) means you want the associated footnote text for all Footnote instructions found in the included text to become part of the document created during the merge function. All Footnote instructions are changed to refer to the correct system page.

The value N (no) means you want the associated footnote text for all Footnote instructions found in the included text to remain outside of the document created during the merge function.

Confirm on delivery. Whether to receive a notice in your outgoing mail log confirming that the note you sent has been delivered.

0 No
1 Yes

Data document name. The name of the document that contains the data to be merged.

The document name must be 1 to 12 characters in length.

Data file library name. The name of the library where the data file is located.

Data file member name. The name of the member that contains data.

Data file name. The name of the file to merge data from.

Data folder name. The name of the folder that contains the document that has the data to be merged.

Delay printing. The value Y (yes) delays printing your labels. The labels are held on the output queue where you can release them to print or delete them if you do not want them to print.

Device file name. The name of the file that contains the information about the device. Use the value 3 for file.

Device library name. A user-defined word that names a library. The value is *LIBL.

Device member name. The value *FILE for the member name, means the member with the same name as the file name will be used. The values are *FILE, *FIRST, and *LAST.

Disclose recipients. Whether your list of addressee and copy list recipients should be revealed to your recipients.

0 No
1 Yes

Display document details display. Whether you want the Document Details display shown. The values are Y (yes) or N (no).

Display exit. Whether the exit panel should be displayed.

0 No
1 Yes

Display exit display. Whether you want the exit display shown. The values are Y (yes) or N (no).

Display status. Whether status lines should be shown on the fill form display.

0 No
1 Yes

Document is a label document. The value (yes or no) identifies if the document is a label document. A label document contains the labels you are printing.

Draft spacing. The value Y (yes) doubles the spacing value in the Line spacing prompt on the Line Spacing/Justification Options display. For example, if the Line spacing prompt is 3 (Triple), the doubled spacing value is 6 and five blank lines are printed between each line of text in your document.

Dump data file. The name of the output file that will contain the form fill data.

Edit document. The values (yes or no) indicate whether you want to edit the document.

Ending page number. A number from 1.0 through 9999.99 or *FIRST or *LAST to specify the page on which you want spell checking to stop.

Error log form type. The forms type for the type of paper on which you want the error log to be printed. If you use the value *STD as the forms type, the error log will be printed on the paper specified in the printer file for the printer you selected. A printer file contains information controlling how your document is printed on a particular printer.

File library. The library to contain the dump data file.

File member. The member to contain the dump data. *FIRST is a special value indicating the first member of the file.

Form type. The host system form type for the forms control table (FCT) entry.

Function. Whether the user is forwarding or replying to a mail item or is sending a note or document.

0 User application send function requested from Send
1 User application send function requested from Forward/Reply

Grade of delivery. Allows you to specify the speed of the network for a note or message to be sent. The following values indicate the grade of delivery to use:

1 High

The distribution will be sent with the highest priority on the fastest distribution lines. It will appear highlighted in a user's mail log until the user takes action on it.
2 Normal

The note or message is sent through normal distribution channels.
3 Low

No special priorities or distribution methods will be used to send the note or message

Graphic character set. The graphic character-set ID that you want to print your job. A graphic character-set ID is an identifier used to specify a set of graphic characters in a code page. This identifier can be two 4-digit prompts separated by a blank or by a hyphen.

Importance. The importance the originator places on the content of the note. Values are as follows:

1 High
2 Normal
3 Low

Job description library name. The library name by specifying one of the following:

name The name of the library that is storing your job description.
*LIBL If you use *LIBL, your library list is searched for the job description.

Job description name. The name of the job description that describes how the job is to be run.

Large print. The value Y (yes) prints your document with large print.

The value N (no) indicates that you do not want to print your document with large print.

Log outgoing mail status. Whether the distribution should be recorded in the outgoing mail status.

0 No
1 Yes

Mail reference document name. The document name where a mail item is referred.

Mail reference folder name. The folder name where the referenced document is filed.

Merge type. The value identifies the way the documents are merged. The values are:

1 Query
2 Document
3 File and Blank

Memo slip character set. The graphic character set ID of your memo slip. A graphic character set ID is an identifier used to specify a set of graphic characters in a code page.

Memo slip code page. The graphic code page of your memo slip. A graphic code page is a particular assignment of hexadecimal identifiers to graphic characters.

Multiple line report. The value Y (yes) means you want to create a multiple line report. A multiple line report merges Data Field instructions to create a report where each record of data produces several lines of output.

The value N (no) means you do not want to create a multiple line report.

Number of addressees. The number of user ID (DEN) and user address (DGN) pairs considered primary or addressee recipients contained in DOCI0900 format. The maximum is 32 767.

Number of blind copy list recipients. The number of user ID (DEN) and user address (DGN) pairs considered blind copy list recipients contained in DOCI0900 format. The maximum is 32 767.

Number of copies to print. The quantity of copies you want printed. The valid values are from 1 through 99.

Number of copy list recipients. The number of user ID (DEN) and user address (DGN) pairs that are considered copy list recipients contained in DOCI0900 format. The maximum is 32 767.

Number of labels. The value that identifies the amount or quantity of labels on a page. The valid values are from 1 through 99.

Number of rows per sheet. If you selected Y (yes) for the Sheet feed labels prompt, this value from 1 through 99, is the number of rows of labels that you want printed on a page.

Offset to recipient list. The byte offset from the beginning of the structure (base 0) to the start of the variable section containing the recipient list.

Output data on exit. Whether the output data is placed to an output file. The values are:

1 Yes
2 No

Output device. A device in a system by which data can be received from the system. The values are:

1 Printer
2 Display
3 File

Output file name. This is the name of the spooled file that is created. The values are *DOC and *FILE.

Output queue library name. The name of the library being used as the current library during the processing of this command. The value is *LIBL.

Output queue name. A list of output files to be printed or displayed. The output queue is used for spooled files. The values are *DEV, *FILE, and *WRKSTN.

Place on job queue. A document can be merged on the job queue.

Use the value Y (yes) if you want the document merged on the job queue. You can then continue working on your display while the document is being merged on the job queue.

Use the value N (no) if you want the job to merge interactively.

Print change symbols. The value Y (yes) prints revision symbols in the left margin of your document. Revision or change symbols are used to indicate lines that have been revised since the last time the document was changed. The revision symbol character is specified on the Change Editing Options display.

Use N (no) if you do not want to print the revision symbols in the left margin of your document.

Print error log. The value Y (yes) prints the error log page at the end of your document. The log contains any errors that were found while the document was being prepared for printing or errors found when a document was sent from another system. The log can also contain informational messages. If your document does not contain print errors, no log will be printed.

Print from pages 1 through 7. A number from 0.01 through 9999.99 to specify the page on which you want printing to start. Other valid values are *FIRST, *LAST, or *STRPAGE. If you use *FIRST, printing is started on the first page of the document. If you use *LAST, printing is started on the last page of the document. If you use *STRPAGE, the To page and From page values are the same and only one page is printed. The From page and To page prompts tell the printer to print specific pages from your document. The page values specified are the pages from the printed document.

Print line numbers. The value Y (yes) prints line numbers in your document. The line numbers begin with 1 on the first page of your document. Line numbers are not printed in headers or footers.

The value N (no) means you do not want to print line numbers in your document.

Print on both sides. The value indicates if you want your document printed on one side or both sides of a page. The values are:

1 No
2 Yes
3 Tumble

Print quality. The value indicates the quality of printing you want to use. The values are:

1 Letter

Letter-quality type is better print but causes wear on the printer ribbon (if your printer uses a ribbon) because the ribbon is struck harder.
2 Text

Text-quality type is not as good as letter-quality type, but is better than draft-quality type.
3 Draft

Draft-quality type saves wear on the printer ribbon (if your printer uses a ribbon) because the ribbon is not struck as hard as it would be if you were using letter-quality type or text-quality type.

Print separator page. A value that determines if sheets will separate the jobs in the printer. The value Y (yes) prints a separator page that includes such things as the document name, folder, document description, subject, reference, and authors. This is useful for separating your document from other documents.

Use N (no) if you do not want to print a separator page.

Print to pages 1 through 7. A number from 0.01 to 9999.99 is the page on which you want printing to stop. Other valid values are *FIRST and *LAST. If you use *FIRST, printing is ended on the first page of the document. If you use *LAST, printing is ended on the last page of the document. The From page and To page prompts tell the printer to print specific pages from your document. The page values specified are the pages from the printed document.

Printer device name. A device that writes output data from a system on paper or other media.

Printer file library name. The library name of the printer file. Possible values are:

name The name of the library in which the printer file is stored.
*LIBL If you specify *LIBL, your library list is searched first for the printer file.

Printer file name. The name of the file where you want the printed labels to be received and stored. A file is a group of records that are related and treated as a unit. If the file does not exist, a new file will be created for you. If the file already exists, the document will be added to the end of the file.

Query library name. The name of the library that contains the query.

Query name. The name of the query that contains data to be merged.

Reference. The reference of the note or document being passed. This will be blank if the user did not enter a reference.

Reference character set. The graphic character-set ID of the reference. A graphic character-set is an identifier used to specify a set of graphic characters in a code page.

Reference code page. The code page ID of the reference. The code page is a particular assignment of hexadecimal identifiers to graphic characters.

Renumber system page numbers. The value Y (yes) renumbers the system page numbers.

The value N (no) keeps the same system page numbers.

Replace document. Whether the document replaces the existing document (yes) or is added to the existing documents (no).

Replace form. Whether the save form should be replaced if it already exists.

0 No
1 Yes

Replace or add. Whether the data is added or replaced in the file member.

A Add
R Replace

Reply requested. Whether the originator has requested a reply.

0 No
1 Yes

Reply requested date. The format is CYYMMDD, where C indicates the century digits. For example, 0 indicates years of the format 19xx, and 1 indicates years of the format 20xx.

Reply requested time. The format is HHMMSS.

Reserved. An ignored field.

Resolve instructions. The value Y (yes) processes the instructions that you have placed in your document.

Resolved output document. The saved document is a resolved document (saved in printed form), that is, page endings are adjusted, line endings are adjusted, headers and footers are put in, and instructions are processed (optional). If you wish to print this document again, it takes less time to print because this document is already in printed form. (A resolved document is a document with the text instructions processed.) This document can be from the text editor or another system.

Resolved output folder. The name of the folder that will contain the document you specified in the Document name prompt. If the folder does not exist, a message is shown before it is created.

Save folder. The folder name where the save form document is saved.

Save form. The name of the document to save the results of the fill form process.

Save resolved output. The value Y (yes) means the document you are printing is saved in the document specified in the document prompt.

The value N (no) means you do not want the document you are printing saved in another document.

Send completion message. The value Y (yes) means you are putting your print job on the job queue and you want a message sent to your display station when the job has completed.

The value N (no) means you are putting your print job on the job queue and you do not want a message sent to your display station when the job has completed.

Sensitivity. An indicator of the sensitivity of the content of the note. Values are as follows:

1 None
2 Personal
3 Private
4 Confidential

Shell folder. The folder containing the shell form.

Shell form. The shell document for fill form.

Sheet-feed labels. A value that defines that a device is attached to a printer to automatically feed out sheets of labels. The value Y (yes) means you are sheet-feed printing and want more than one row of labels on a page. If you are using sheet-feed paper, there is no other way to print more than one row of labels on a page.

Show exit display. Whether you want the exit display shown. The valid values are Y (yes) or N (no).

Size of format. The complete size of format DOCI0900, including any variable length records.

Subject. The subject of the note or document being passed. This will be blank if the user did not enter a subject.

Subject character set. The graphic character set ID of the subject. A graphic character set is an identifier used to specify a set of graphic characters in a code page.

Subject code page. The code page ID of the subject. The code page is a particular assignment of hexadecimal identifiers to graphic characters.

To document name. The name of the document to be merged with.

To folder name. The name of the folder that will contain the document being created.

Type of check. The value indicates if you want to check the spelling or the grade level.

0 Spell
1 Grade

User address. The recipient address or DGN.

User ID. The recipient name or DEN.

User's memo slip text. User's text typed on the Attach Memo Slip display.

Width of labels. The width of a label is the number of characters from the left edge of the first label to the left edge of the next label, including the blank spaces between the labels. If the width you specify is larger than the margins for your document, the margins are used as the width. Valid values are 2 through 198.

Note: For the printer device field the special values *SYSVAL, *USRPRF, and *WRKSTN are replaced with the appropriate printer name, therefore the exit program does not use the special values.


Error Messages

Message ID Error Message Text
OFC169A User exit programs canceled by program &1 in library &2.
OFC169B Error with administration user exit programs.
OFC1691 Error occurred using Office application enabler.
OFC1695 Error occurred when calling program &1 in library &2.
OFC1696 Return code &1 from program &2 in library &3 not valid.
OFC1698 Error calling user exit program &1 in library &2.
OFC1699 Error on retrieval of user exit program.
OFC2096 The user application send processing has returned &1.

Exit program introduced: V2R2
Top | Office APIs | APIs by category