Converting SAP Script outputs to PDF file

Transcription

1 SDN Contribution Converting SAP Script outputs to PDF file Applies to: SAP R/3 46C ABAP / SAPSCRIPTS Summary These code snippets explain how to convert single as well as multiple SAP Script output into a single PDF file to be downloaded in the local system In the case of multiple SAP Scripts, the outputs are merged into a single OTF data and then converted to PDF data This is done without creating any spool request Author(s): Indrajit Chakraborti Company: Wipro Technologies Created on: 3 August 2006 Author Bio I am an SAP ABAP consultant in Wipro Technologies 2006 SAP AG 1

2 Table of Contents Author Bio 1 Converting Single SAP Script output into PDF file 3 Methodology 3 Code Snippet 3 Output 12 Converting Multiple SAP Script outputs into single PDF file 15 Methodology 15 Code Snippet 15 Output 26 Disclaimer and Liability Notice SAP AG 2

3 Converting Single SAP Script output into PDF file Methodology The SAP Script output is internally represented in OTF format which is normally not visible to the user This internal format is accessed in this program by setting the TDGETOTF field of the structure of type ITCPO and passing the structure to the OPTIONS parameter of the function module OPEN_FORM To suppress the dialog box in SAP Script asking for Printer details, the DIALOG parameter of OPEN_FORM is assigned to SPACE The SAP Script is generated using the Function modules START_FORM, WRITE_FORM and END_FORM In the function module CLOSE_FORM, the OTF output for the SAPscript is obtained in the Tables parameter OTFDATA by assigning an internal table of structure type ITCOO This internal table data is converted to PDF data using the function module CONVERT_OTF, which will also return the size of PDF data This PDF data is generated in an internal table of Structure type TLINE The PDF data is downloaded into a PDF file in the local system using the Function module GUI_DOWNLOAD The path where the file will be downloaded is taken as user input using the method FILE_SAVE_DIALOG of the class CL_GUI_FRONTEND_SERVICES Code Snippet REPORT Z1SCRIPT_TO_PDF ****************************DECLARATIONS******************************** DATA: BEGIN OF ITAB OCCURS 0, CARRID TYPE SFLIGHT-CARRID, CONNID TYPE SFLIGHT-CONNID, PRICE TYPE SFLIGHT-PRICE, END OF ITAB DATA: struct TYPE ITCPO DATA: PDFTAB TYPE TABLE OF TLINE WITH HEADER LINE, DATAB TYPE TABLE OF ITCOO WITH HEADER LINE, DATA: BINFILESIZE TYPE I, FILE_NAME TYPE STRING, FILE_PATH TYPE STRING, FULL_PATH TYPE STRING 2006 SAP AG 3

4 ****************************END OF DECLARATIONS******************************** *To specify Printer name* struct-tddest = 'LP01' *To specify no Print Preview* struct-tdnoprev = 'X' *To access the SAP Script output in OTF format* struct-tdgetotf = 'X' ***************************SAPSCRIPT GENERATION******************************** CALL FUNCTION 'OPEN_FORM' EXPORTING * APPLICATION = 'TX' * ARCHIVE_INDEX = * ARCHIVE_PARAMS = DEVICE = 'PRINTER' DIALOG = space FORM = 'ZSCRIPT' * LANGUAGE = SY-LANGU OPTIONS = struct * MAIL_SENDER = * MAIL_RECIPIENT = * MAIL_APPL_OBJECT = * RAW_DATA_INTERFACE = '*' * SPONUMIV = * LANGUAGE = * NEW_ARCHIVE_PARAMS = * RESULT = CANCELED = 1 DEVICE = 2 FORM = SAP AG 4

5 OPTIONS = 4 UNCLOSED = 5 MAIL_OPTIONS = 6 ARCHIVE_ERROR = 7 INVALID_FAX_NUMBER = 8 MORE_PARAMS_NEEDED_IN_BATCH = 9 SPOOL_ERROR = 10 CODEPAGE = 11 OTHERS = 12 IF sy-subrc <> 0 CALL FUNCTION 'START_FORM' EXPORTING * ARCHIVE_INDEX = FORM = 'ZSCRIPT' * LANGUAGE = ' ' * STARTPAGE = ' ' * PROGRAM = ' ' * MAIL_APPL_OBJECT = * LANGUAGE = FORM = 1 FORMAT = 2 UNENDED = 3 UNOPENED = 4 UNUSED = 5 SPOOL_ERROR = 6 CODEPAGE = 7 OTHERS = SAP AG 5

6 IF sy-subrc <> 0 CALL FUNCTION 'WRITE_FORM' EXPORTING ELEMENT = 'ELEM1' FUNCTION = 'SET' TYPE = 'BODY' WINDOW = 'MAIN' * PENDING_LINES = ELEMENT = 1 FUNCTION = 2 TYPE = 3 UNOPENED = 4 UNSTARTED = 5 WINDOW = 6 BAD_PAGEFORMAT_FOR_PRINT = 7 SPOOL_ERROR = 8 CODEPAGE = 9 OTHERS = 10 IF sy-subrc <> 0 SELECT CARRID CONNID PRICE FROM SFLIGHT INTO TABLE ITAB LOOP AT ITAB CALL FUNCTION 'WRITE_FORM' 2006 SAP AG 6

7 EXPORTING ELEMENT = 'ELEM2' FUNCTION = 'SET' TYPE = 'BODY' WINDOW = 'MAIN' * PENDING_LINES = ELEMENT = 1 FUNCTION = 2 TYPE = 3 UNOPENED = 4 UNSTARTED = 5 WINDOW = 6 BAD_PAGEFORMAT_FOR_PRINT = 7 SPOOL_ERROR = 8 CODEPAGE = 9 OTHERS = 10 IF sy-subrc <> 0 ENDLOOP CALL FUNCTION 'END_FORM' * RESULT = UNOPENED = 1 BAD_PAGEFORMAT_FOR_PRINT = 2 SPOOL_ERROR = 3 CODEPAGE = 4 OTHERS = SAP AG 7

8 IF sy-subrc <> 0 CALL FUNCTION 'CLOSE_FORM' * RESULT = * RDI_RESULT = TABLES OTFDATA = DATAB[] UNOPENED = 1 BAD_PAGEFORMAT_FOR_PRINT = 2 SEND_ERROR = 3 SPOOL_ERROR = 4 CODEPAGE = 5 OTHERS = 6 IF sy-subrc <> 0 ***************************END OF SAPSCRIPT GENERATION******************************** ***************************CONVERTING OTF DATA TO PDF DATA**************************** CALL FUNCTION 'CONVERT_OTF' EXPORTING FORMAT = 'PDF' * MAX_LINEWIDTH = 132 * ARCHIVE_INDEX = ' ' 2006 SAP AG 8

9 * COPYNUMBER = 0 * ASCII_BIDI_VIS2LOG = ' ' * PDF_DELETE_OTFTAB = ' ' IMPORTING BIN_FILESIZE = BINFILESIZE * BIN_FILE = TABLES otf = DATAB[] lines = PDFTAB[] * * ERR_MAX_LINEWIDTH = 1 * ERR_FORMAT = 2 * ERR_CONV_NOT_POSSIBLE = 3 * ERR_BAD_OTF = 4 * OTHERS = 5 IF sy-subrc <> 0 *****************TAKING THE DOWNLOAD FILE PATH AS USER INPUT************************* CALL METHOD cl_gui_frontend_services=>file_save_dialog * EXPORTING * WINDOW_TITLE = * DEFAULT_EXTENSION = * DEFAULT_FILE_NAME = * FILE_FILTER = * INITIAL_DIRECTORY = * WITH_ENCODING = * PROMPT_ON_OVERWRITE = 'X' CHANGING 2006 SAP AG 9

10 filename = FILE_NAME path = FILE_PATH fullpath = FULL_PATH * USER_ACTION = * FILE_ENCODING = * * CNTL_ERROR = 1 * ERROR_NO_GUI = 2 * NOT_SUPPORTED_BY_GUI = 3 * others = 4 IF sy-subrc <> 0 ****************************DOWNLOADING THE PDF DATA********************************** CALL FUNCTION 'GUI_DOWNLOAD' EXPORTING BIN_FILESIZE FILENAME FILETYPE = binfilesize = 'D:\myfilepdf' = 'BIN' * APPEND = ' ' * WRITE_FIELD_SEPARATOR = ' ' * HEADER = '00' * TRUNC_TRAILING_BLANKS = ' ' * WRITE_LF = 'X' * COL_SELECT = ' ' * COL_SELECT_MASK = ' ' * DAT_MODE = ' ' * CONFIRM_OVERWRITE = ' ' * NO_AUTH_CHECK = ' ' * CODEPAGE = ' ' 2006 SAP AG 10

11 * IGNORE_CERR = ABAP_TRUE * REPLACEMENT = '#' * WRITE_BOM = ' ' * TRUNC_TRAILING_BLANKS_EOL = 'X' * WK1_N_FORMAT = ' ' * WK1_N_SIZE = ' ' * WK1_T_FORMAT = ' ' * WK1_T_SIZE = ' ' * FILELENGTH = tables data_tab = PDFTAB[] * FIELDNAMES = FILE_WRITE_ERROR = 1 NO_BATCH = 2 GUI_REFUSE_FILETRANSFER = 3 INVALID_TYPE = 4 NO_AUTHORITY = 5 UNKNOWN_ERROR = 6 HEADER_NOT_ALLOWED = 7 SEPARATOR_NOT_ALLOWED = 8 FILESIZE_NOT_ALLOWED = 9 HEADER_TOO_LONG = 10 DP_ERROR_CREATE = 11 DP_ERROR_SEND = 12 DP_ERROR_WRITE = 13 UNKNOWN_DP_ERROR = 14 ACCESS_DENIED = 15 DP_OUT_OF_MEMORY = 16 DISK_FULL = 17 DP_TIMEOUT = 18 FILE_NOT_FOUND = 19 DATAPROVIDER_EXCEPTION = 20 CONTROL_FLUSH_ERROR = SAP AG 11

12 OTHERS = 22 IF sy-subrc <> 0 Output Pop up asking user to specify location where the output PDF file is to be stored 2006 SAP AG 12

13 File stored in the path provided by the user 2006 SAP AG 13

14 Single SAPScript output in PDF format 2006 SAP AG 14

15 Converting Multiple SAP Script outputs into single PDF file Methodology The methodology adopted for this is similar to previous case except that multiple SAPScript outputs are merged into a single OTF data which is then converted to PDF file Between function modules OPEN_FORM and CLOSE_FORM, for each SAP Script a set of 3 function modules START_FORM, WRITE_FORM and END_FORM is used In the function module START_FORM the name of corresponding SAPScript is specified The merged OTF data for multiple SAPScripts is obtained in the Tables parameter OTFDATA of the function module CLOSE_FORM This is converted to PDF data using similar method as explained in the previous case Code Snippet REPORT ZMULTIPLE_SCRIPT_TO_PDF ****************************DECLARATIONS******************************** DATA: BEGIN OF ITAB OCCURS 0, CARRID TYPE SFLIGHT-CARRID, CONNID TYPE SFLIGHT-CONNID, PRICE TYPE SFLIGHT-PRICE, END OF ITAB DATA: struct TYPE ITCPO DATA: PDFTAB TYPE TABLE OF TLINE WITH HEADER LINE, DATAB TYPE TABLE OF ITCOO WITH HEADER LINE, DATA: BINFILESIZE TYPE I, FILE_NAME TYPE STRING, FILE_PATH TYPE STRING, FULL_PATH TYPE STRING ****************************END OF DECLARATIONS*************************** *To specify Printer name* struct-tddest = 'LP01' 2006 SAP AG 15

16 *To specify no Print Preview* struct-tdnoprev = 'X' *To access the SAP Script output in OTF format* struct-tdgetotf = 'X' ***************************SAPSCRIPTS GENERATION******************************** CALL FUNCTION 'OPEN_FORM' EXPORTING * APPLICATION = 'TX' * ARCHIVE_INDEX = * ARCHIVE_PARAMS = DEVICE = 'PRINTER' DIALOG = space * FORM = * LANGUAGE = SY-LANGU OPTIONS = struct * MAIL_SENDER = * MAIL_RECIPIENT = * MAIL_APPL_OBJECT = * RAW_DATA_INTERFACE = '*' * SPONUMIV = * LANGUAGE = * NEW_ARCHIVE_PARAMS = * RESULT = CANCELED = 1 DEVICE = 2 FORM = 3 OPTIONS = 4 UNCLOSED = 5 MAIL_OPTIONS = 6 ARCHIVE_ERROR = 7 INVALID_FAX_NUMBER = SAP AG 16

17 MORE_PARAMS_NEEDED_IN_BATCH = 9 SPOOL_ERROR = 10 CODEPAGE = 11 OTHERS = 12 IF sy-subrc <> 0 ************************GENERATION OF FIRST SAP SCRIPT*********************************** CALL FUNCTION 'START_FORM' EXPORTING * ARCHIVE_INDEX = FORM = 'ZSCRIPT1' * LANGUAGE = ' ' * STARTPAGE = ' ' * PROGRAM = ' ' * MAIL_APPL_OBJECT = * LANGUAGE = FORM = 1 FORMAT = 2 UNENDED = 3 UNOPENED = 4 UNUSED = 5 SPOOL_ERROR = 6 CODEPAGE = 7 OTHERS = 8 IF sy-subrc <> SAP AG 17

18 CALL FUNCTION 'WRITE_FORM' EXPORTING ELEMENT = 'ELEM1' FUNCTION = 'SET' TYPE = 'BODY' WINDOW = 'MAIN' * PENDING_LINES = ELEMENT = 1 FUNCTION = 2 TYPE = 3 UNOPENED = 4 UNSTARTED = 5 WINDOW = 6 BAD_PAGEFORMAT_FOR_PRINT = 7 SPOOL_ERROR = 8 CODEPAGE = 9 OTHERS = 10 IF sy-subrc <> 0 SELECT CARRID CONNID PRICE FROM SFLIGHT INTO TABLE ITAB LOOP AT ITAB CALL FUNCTION 'WRITE_FORM' EXPORTING ELEMENT FUNCTION TYPE = 'ELEM2' = 'SET' = 'BODY' 2006 SAP AG 18

19 WINDOW = 'MAIN' * PENDING_LINES = ELEMENT = 1 FUNCTION = 2 TYPE = 3 UNOPENED = 4 UNSTARTED = 5 WINDOW = 6 BAD_PAGEFORMAT_FOR_PRINT = 7 SPOOL_ERROR = 8 CODEPAGE = 9 OTHERS = 10 IF sy-subrc <> 0 ENDLOOP CALL FUNCTION 'END_FORM' * RESULT = UNOPENED = 1 BAD_PAGEFORMAT_FOR_PRINT = 2 SPOOL_ERROR = 3 CODEPAGE = 4 OTHERS = 5 IF sy-subrc <> SAP AG 19

20 ***********************END OF GENERATION OF FIRST SAPSCRIPT************************ ************************GENERATION OF SECOND SAP SCRIPT**************************** CALL FUNCTION 'START_FORM' EXPORTING * ARCHIVE_INDEX = FORM = 'ZSCRIPT2' * LANGUAGE = ' ' * STARTPAGE = ' ' * PROGRAM = ' ' * MAIL_APPL_OBJECT = * LANGUAGE = FORM = 1 FORMAT = 2 UNENDED = 3 UNOPENED = 4 UNUSED = 5 SPOOL_ERROR = 6 CODEPAGE = 7 OTHERS = 8 IF sy-subrc <> 0 CALL FUNCTION 'WRITE_FORM' EXPORTING ELEMENT FUNCTION TYPE WINDOW = 'ELEMENT1' = 'SET' = 'BODY' = 'MAIN' 2006 SAP AG 20

21 * PENDING_LINES = ELEMENT = 1 FUNCTION = 2 TYPE = 3 UNOPENED = 4 UNSTARTED = 5 WINDOW = 6 BAD_PAGEFORMAT_FOR_PRINT = 7 SPOOL_ERROR = 8 CODEPAGE = 9 OTHERS = 10 IF sy-subrc <> 0 CALL FUNCTION 'END_FORM' * RESULT = * * UNOPENED = 1 * BAD_PAGEFORMAT_FOR_PRINT = 2 * SPOOL_ERROR = 3 * CODEPAGE = 4 * OTHERS = 5 IF sy-subrc <> 0 ***********************END OF GENERATION OF SECOND SAPSCRIPT************************ 2006 SAP AG 21

22 CALL FUNCTION 'CLOSE_FORM' * RESULT = * RDI_RESULT = TABLES OTFDATA = datab[] UNOPENED = 1 BAD_PAGEFORMAT_FOR_PRINT = 2 SEND_ERROR = 3 SPOOL_ERROR = 4 CODEPAGE = 5 OTHERS = 6 IF sy-subrc <> 0 *******************END OF SAPSCRIPTS GENERATION************************************* ***************************CONVERTING OTF DATA TO PDF DATA************************** CALL FUNCTION 'CONVERT_OTF' EXPORTING FORMAT = 'PDF' * MAX_LINEWIDTH = 132 * ARCHIVE_INDEX = ' ' * COPYNUMBER = 0 * ASCII_BIDI_VIS2LOG = ' ' * PDF_DELETE_OTFTAB = ' ' IMPORTING BIN_FILESIZE = BINFILESIZE * BIN_FILE = TABLES 2006 SAP AG 22

23 otf = DATAB[] lines = PDFTAB[] * * ERR_MAX_LINEWIDTH = 1 * ERR_FORMAT = 2 * ERR_CONV_NOT_POSSIBLE = 3 * ERR_BAD_OTF = 4 * OTHERS = 5 IF sy-subrc <> 0 *****************TAKING THE DOWNLOAD FILE PATH AS USER INPUT************************* CALL METHOD cl_gui_frontend_services=>file_save_dialog * EXPORTING * WINDOW_TITLE = * DEFAULT_EXTENSION = * DEFAULT_FILE_NAME = * FILE_FILTER = * INITIAL_DIRECTORY = * WITH_ENCODING = * PROMPT_ON_OVERWRITE = 'X' CHANGING filename = FILE_NAME path = FILE_PATH fullpath = FULL_PATH * USER_ACTION = * FILE_ENCODING = * * CNTL_ERROR = 1 * ERROR_NO_GUI = 2 * NOT_SUPPORTED_BY_GUI = 3 * others = SAP AG 23

24 IF sy-subrc <> 0 ****************************DOWNLOADING THE PDF DATA********************************** CALL FUNCTION 'GUI_DOWNLOAD' EXPORTING BIN_FILESIZE = binfilesize FILENAME = full_path FILETYPE = 'BIN' * APPEND = ' ' * WRITE_FIELD_SEPARATOR = ' ' * HEADER = '00' * TRUNC_TRAILING_BLANKS = ' ' * WRITE_LF = 'X' * COL_SELECT = ' ' * COL_SELECT_MASK = ' ' * DAT_MODE = ' ' * CONFIRM_OVERWRITE = ' ' * NO_AUTH_CHECK = ' ' * CODEPAGE = ' ' * IGNORE_CERR = ABAP_TRUE * REPLACEMENT = '#' * WRITE_BOM = ' ' * TRUNC_TRAILING_BLANKS_EOL = 'X' * WK1_N_FORMAT = ' ' * WK1_N_SIZE = ' ' * WK1_T_FORMAT = ' ' * WK1_T_SIZE = ' ' * FILELENGTH = tables 2006 SAP AG 24

25 data_tab = PDFTAB[] * FIELDNAMES = FILE_WRITE_ERROR = 1 NO_BATCH = 2 GUI_REFUSE_FILETRANSFER = 3 INVALID_TYPE = 4 NO_AUTHORITY = 5 UNKNOWN_ERROR = 6 HEADER_NOT_ALLOWED = 7 SEPARATOR_NOT_ALLOWED = 8 FILESIZE_NOT_ALLOWED = 9 HEADER_TOO_LONG = 10 DP_ERROR_CREATE = 11 DP_ERROR_SEND = 12 DP_ERROR_WRITE = 13 UNKNOWN_DP_ERROR = 14 ACCESS_DENIED = 15 DP_OUT_OF_MEMORY = 16 DISK_FULL = 17 DP_TIMEOUT = 18 FILE_NOT_FOUND = 19 DATAPROVIDER_EXCEPTION = 20 CONTROL_FLUSH_ERROR = 21 OTHERS = 22 IF sy-subrc <> SAP AG 25

26 Output Pop up asking user to specify location where the output PDF file is to be stored File stored in the path provided by the user 2006 SAP AG 26

27 Multiple SAPScript outputs in PDF format 2006 SAP AG 27

28 First Page Second Page 2006 SAP AG 28

29 Disclaimer and Liability Notice This document may discuss sample coding or other information that does not include SAP official interfaces and therefore is not supported by SAP Changes made based on this information are not supported and can be overwritten during an upgrade SAP will not be held liable for any damages caused by using or misusing the information, code or methods suggested in this document, and anyone using these methods does so at his/her own risk SAP offers no guarantees and assumes no responsibility or liability of any type with respect to the content of this technical article or code sample, including any liability resulting from incompatibility between the content within this document and the materials and services offered by SAP You agree that you will not hold, or seek to hold, SAP responsible or liable with respect to the content of this document 2006 SAP AG 29