The module EFG_PRINT reflects the central interface for printing an application form. The parameters of the module contain
· All controlling information for the Print Workbench (for example, application form, form class)
· Control information for the print process (for example, output formats, ITCPO)
· Information for the data procurement of the form class (ranges tables)
The call of the module is independent of the form, the form class, and the form tool used (SAPscript, Smart Form, or PDF-based form).
The interface of the module consists of the following parameters:
Import parameters
X_PRINTPARAMS |
EPRINTPARAMS |
Structure of the print parameters |
X_ARCHIVE_INDEX |
TOA_DARA |
Archive information per document (optional) |
X_ARCHIVE_PARAMS |
ARC_PARAMS |
General archive information (optional) |
X_DIALOG |
(Indicator) |
Execute dialog for print parameters (optional, default: SPACE) |
X_RECIPIENT |
SWOTOBJID |
Object handle for recipient (optional) |
X_SENDER |
SWOTOBJID |
Object handle for sender (optional) |
Export parameters
Y_PRINTPARAMS |
EPRINTPARAMS |
Print Workbench result structure |
Y_RDI_RESULT
|
RDIRESULT |
Result of RDI print |
Y_PRINTPARAMS
|
EPRINTPARAMS |
Print Workbench result structure |
Y_SF_RESULT |
SSFCRESCL |
Result of printing by Smart Form |
Table parameters
XT_RANGES<number> |
EFG_RANGES |
Ranges table for interpretation of data selection in form class |
YT_OTF_DATA |
ITCOO |
OTF data returned (if required by application) |
The most important control information for printing is in the import structure X_PRINTPARAMS (for example, application form, printer). The user can also set or modify these by calling the module EFG_GET_PRINT_PARAMETERS.
The archiving data that belongs to the application (for example, document type, BOR object type, BOR object ID) is transferred in both import structures X_ARCHIVE_INDEX and X_ARCHIVE_PARAMS; without this data, optical archiving of correspondence is not possible. You can also use module EFG_GET_ARCHIVE_PARAMS to fill these structures. Both object reference IDs X_RECIPIENT and X_SENDER are of the type RECIPIENT and must be created with the BOR methods first.
You can only print application forms that have the status Active. If the module EFG_PRINT is called, first the status of the form is checked. If the status is not Active, an activation of the form and generation of the related print program are triggered.