PERSONALIZE_DOC SAP Method Trigger Exec.: Ext. Com. Personalize Doc (PDF Only) Chk Doc
Below is documentation, parameters and attributes of ABAP Method PERSONALIZE_DOC within SAP class /BOFU/IF_PPF_SERV_FOR_BO. There is also a number of example ABAP code snipts to help you use the functionality of this method.
This method is available within SAP systems depending on your version and release level, you can view further information by entering the class name /BOFU/IF_PPF_SERV_FOR_BO into the relevant SAP transactions such as SE24 or SE80, and then selecting the method you are interested in.
Method Type - Instance
This is an Instance Method so needs to be instantiated first before you can access any of the methods. I.e. you need to create a local variable of TYPE ref to the class.The following technical details of method PERSONALIZE_DOC can also be found below:
- Importing parameters
- Exporting parameters
- Changing parameters
- Returning parameters
- Exceptions
- Coding Examples
Parameters of Method PERSONALIZE_DOC
.| Name | Type | Data Type | Description | Default Value |
| IO_CONTAINER | Importing | TYPE REF TO /BOFU/CL_PPF_CONTAINER | Output Mgmt for BOPF BOs: Persistant Container | |
| IO_MESSAGE | Importing | TYPE REF TO /BOBF/IF_FRW_MESSAGE | Application Log: Log Handle | |
| IO_PERSONALIZE_DATA | Importing | TYPE REF TO CL_PERSONALIZE_DATA_BCS | Service Class for Personalization of a Mail | |
| IP_FORM_NAME | Importing | TYPE FPNAME | Name of Form Object | |
| IP_FUNCTION_NAME | Importing | TYPE RS38L_FNAM | Name of Function Module | |
| IP_USER_SETTINGS | Importing | TYPE TDBOOL | Checkbox (yes or no) | |
| IS_OUTPUTPARAMS | Importing | TYPE SFPOUTPUTPARAMS | Form Processing Output Parameter | |
| IS_PPF_ACT | Importing | TYPE /BOFU/S_PPF_ACT | Action Settings: Supplementary data 4 PPF Action def | |
| IS_PPF_CONF | Importing | TYPE /BOFU/S_PPF_CONF | BO Node specific settings for PPF usage | |
| IS_PPF_PROF | Importing | TYPE /BOFU/S_PPF_PROF | Assign PPF Action Profiles to BO Nodes | |
| IS_PPF_PTYP | Importing | TYPE /BOFU/S_PPF_PTYP | Action Settings: Supplementary data 4 PPF Proc Typ | |
| IV_LANGUAGE | Importing | TYPE SPRAS | Language Key | |
| EO_MAIN_DOCUMENT | Exporting | TYPE REF TO CL_DOCUMENT_BCS | Wrapper Class for Office Documents | |
| ES_FORMOUTPUT | Exporting | TYPE FPFORMOUTPUT | Form Output (PDF, PDL) | |
| ES_JOBOUTPUT | Exporting | TYPE SFPJOBOUTPUT | Return Form Processing | |
| ET_ATTACHMENTS | Exporting | TYPE BCSY_IFDOC | BCS: Table of References to IF_DOCUMENT_BCS | |
| EV_DOCUMENT_NUMBER | Exporting | TYPE PPFDSORT | Document ID | |
| CP_DOCUMENT_TITLE | Changing | TYPE STRING | ||
| CS_DOCPARAMS | Changing | TYPE SFPDOCPARAMS | Form Parameters for Form Processing |
Exceptions of Method PERSONALIZE_DOC
This method does not have any exceptionsExample ABAP coding
DATA: lo_class TYPE REF TO /BOFU/IF_PPF_SERV_FOR_BO.
DATA: lv_CP_DOCUMENT_TITLE TYPE STRING,
lv_CS_DOCPARAMS TYPE SFPDOCPARAMS,
lv_EO_MAIN_DOCUMENT TYPE CL_DOCUMENT_BCS,
lv_ES_FORMOUTPUT TYPE FPFORMOUTPUT,
lv_ES_JOBOUTPUT TYPE SFPJOBOUTPUT,
lv_ET_ATTACHMENTS TYPE BCSY_IFDOC,
lv_EV_DOCUMENT_NUMBER TYPE PPFDSORT,
lv_IO_CONTAINER TYPE /BOFU/CL_PPF_CONTAINER,
lv_IO_MESSAGE TYPE /BOBF/IF_FRW_MESSAGE,
lv_IO_PERSONALIZE_DATA TYPE CL_PERSONALIZE_DATA_BCS,
lv_IP_FORM_NAME TYPE FPNAME,
lv_IP_FUNCTION_NAME TYPE RS38L_FNAM,
lv_IP_USER_SETTINGS TYPE TDBOOL,
lv_IS_OUTPUTPARAMS TYPE SFPOUTPUTPARAMS,
lv_IS_PPF_ACT TYPE /BOFU/S_PPF_ACT,
lv_IS_PPF_CONF TYPE /BOFU/S_PPF_CONF,
lv_IS_PPF_PROF TYPE /BOFU/S_PPF_PROF,
lv_IS_PPF_PTYP TYPE /BOFU/S_PPF_PTYP,
lv_IV_LANGUAGE TYPE SPRAS,
lv_other TYPE c.
CALL METHOD lo_class=>PERSONALIZE_DOC(
EXPORTING
IO_CONTAINER = lv_IO_CONTAINER
IO_MESSAGE = lv_IO_MESSAGE
IO_PERSONALIZE_DATA = lv_IO_PERSONALIZE_DATA
IP_FORM_NAME = lv_IP_FORM_NAME
IP_FUNCTION_NAME = lv_IP_FUNCTION_NAME
IP_USER_SETTINGS = lv_IP_USER_SETTINGS
IS_OUTPUTPARAMS = lv_IS_OUTPUTPARAMS
IS_PPF_ACT = lv_IS_PPF_ACT
IS_PPF_CONF = lv_IS_PPF_CONF
IS_PPF_PROF = lv_IS_PPF_PROF
IS_PPF_PTYP = lv_IS_PPF_PTYP
IV_LANGUAGE = lv_IV_LANGUAGE
IMPORTING
EO_MAIN_DOCUMENT = lv_EO_MAIN_DOCUMENT
ES_FORMOUTPUT = lv_ES_FORMOUTPUT
ES_JOBOUTPUT = lv_ES_JOBOUTPUT
ET_ATTACHMENTS = lv_ET_ATTACHMENTS
EV_DOCUMENT_NUMBER = lv_EV_DOCUMENT_NUMBER
CHANGING
CP_DOCUMENT_TITLE = lv_CP_DOCUMENT_TITLE
CS_DOCPARAMS = lv_CS_DOCPARAMS ).
Links to Related Class(s)
/BOFU/IF...Full list of available SAP object classes
Search for further information about these or an SAP related objects