Show TOC

Parameters of the Generated Function ModuleLocate this document in the navigation structure

The function module generated from a Smart Form provides a number of standard parameters. After you created a Smart Form these parameters appear directly in the form interface of the Smart Form and cannot be changed. When you call the module from within your application program, you can use these parameters, for example, to specify the output device (printer, FAX, e-mail) or to adapt the spool dialog.

Overview

From the function module's point of view there are import (kind K= I) and export parameters (kind K= E):

Parameter Name

Type

Type

Meaning

ARCHIVE_INDEX

I

TOA_DARA

SAP ArchiveLink parameter for archiving forms (see also: Archiving).

ARCHIVE_INDEX_TAB

I

TSFDARA

ARCHIVE_PARAMETERS

I

ARC_PARAMS

CONTROL_PARAMETERS

I

SSFCTRLOP

Control structure for the general control of the form putput (output medium, output with/without dialog, language, and so on)

MAIL_APPL_OBJ

I

SWOTOBJID

Business Communication Interface (BCI) parameter for sending forms as e-mail (see also: Sending Forms as E-Mail or Telefax)

MAIL_RECIPIENT

I

SWOTOBJID

MAIL_SENDER

I

SWOTOBJID

OUTPUT_OPTIONS

I

SSFCOMPOP

Structure with output options for output to spool, as FAX, or in XSF format

USER_SETTINGS

I

TDBOOL

If the parameter is set ('X'), SAP Smart Forms copies the user defaults for the Spool Control, which you set under Start of the navigation path System Next navigation step User Profile Next navigation step Own Data End of the navigation path ( Output Device, Print Immediately, Delete after Output). If it is not set, SAP Smart Forms instead evaluates the following parameters of the structure for the output options ( SSFCOMOP):

  • Printer specifications ( TDDEST, TDPRINTER, RQPOSNAME)

  • TDIMMED (Print immediately)

  • TDDELETE (Delete after print)

DOCUMENT_OUTPUT_INFO

E

SSFCRESPD

This structure contains nothing but the TDFPAGES field of type TDFPAGES, which contains the number of printed form pages

JOB_OUTPUT_INFO

E

SSFCRESCL

After form output you can use this structure to query which actions produced which results (see: Querying the Output Result)

JOB_OUTPUT_OPTIONS

E

SSFCRESOP

This structure contains a subset of the fields of OUTPUT_OPTIONS: the fields that the user is allowed to change. It enables you to determine whether your settings have been modified.