Document Conversion Exit Program

Required Parameter Group:

1	Input document name	Input	Char(12)
2	Input folder name	Input	Char(63)
3	Input document type	Input	Binary(4)
4	Output document name	Input	Char(12)
5	Output folder name	Input	Char(63)
6	Output document type	Input	Binary(4)
7	Function code	Input	Char(1)
8	Conversion existence indicator	Output	Char(1)

The Document Conversion exit program allows other document conversions to be called when a request is made for the OfficeVision program to process a document type that it does not support. The i5/OS and OfficeVision programs use document conversions when opening documents.

Program Registration

To register a user exit program, use the Change Office Program (QOGCHGOE) API.

Authorities and Locks

None.

Required Parameter Group

Input document name

INPUT; CHAR(12)

The name of the document the function is to be performed against.

Input folder name

INPUT; CHAR(63)

The folder in which the document is to be found.

Input 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 in the range of 1 through 65535.

Output document name

INPUT; CHAR(12)

The name of the output document.

Output folder name

INPUT; CHAR(63)

The folder in which the output document is to be placed.

Output document type

INPUT; BINARY(4)

The format of the document that is being worked with. The value must be in the range of 1 through 65535.

Function code

INPUT; CHAR(1)

Whether the exit is being called to check for the existence of a conversion or to perform the conversion.

0	A conversion is being requested.
1	An existence check is requested.

Conversion existence indicator

OUTPUT; CHAR(1)

Whether the requested conversion exists. This flag must be set for both conversion existence checks and conversion requests.

0	Conversion does not exist.
1	Conversion exists.

Use of Document Conversions by IBM Programs

Other document conversions will be called when you are opening documents and:

Processing the following document commands and using the OfficeVision editor or print functions:

CRTDOC

EDTDOC

DSPDOC

PRTDOC

CHKDOC

MRGDOC

PAGDOC

ADDTXTIDXE

Processing the following options from the Work with Documents in Folders display and using OfficeVision:

Create

Revise

View

Print

Spell

Paginate

Print options

Processing the following options from the Work with Documents in a Document List display:

Revise

View

Print

Processing the following options from the Work with Mail display and using OfficeVision:

Revise a copy

View

Print

Forward

Reply

Copying a document on a create request when using the OfficeVision editor.

Recalling from or copying or moving to a notepad document within the OfficeVision editor.

Using the GET function within the OfficeVision editor.

Including a document with the .inc instruction in the OfficeVision print function.

Accessing external footnote documents in the OfficeVision print function.

Accessing a fill-in document (merge from a document) in the OfficeVision print function.

Accessing shell documents QPROFNOT and QPROFDOC for converting incoming PROFS documents and notes.

Printing mail for indirect office users.

Accessing the shell note when creating a note.

Accessing the output document for a copy graph or image request.

In each of these cases a conversion from the current format to RFTDCA or FFTDCA is requested. A second conversion from this resulting format to i5/OS format may also be performed using the IBM conversion programs.