BSP/HowTo: Generate PDF Output from a BSP.

[craigcmehil]

Have you ever heard the comment from someone, "Boy I sure would like to get this report as a PDF on my computer in order to send it to Bob over in accounting. He doesn't have a login for this BSP application and it'd be great to send him this data." Well I haven't either, OK, not exactly like it but similiar. It left me with two choices, 1, give "Bob" a login or 2, figure out how to output my report as PDF.
Being a frequent visitor to SDN I remembered reading a few things about PDF and outputing so I began my searching...

BSP Programming: Handling Of Non-HTML Documents

Generate file .doc or .pdf as from a text

Well after playing around with the information, and I mean really good information given in these posts/weblogs I realized that I still had a few questions left unanswered. Namely, "How do I get the data as OTF?".

This lead me to post a new topic in the BSP forum called PDF output and with the help my fellow SDNers I think we've come up with all the info needed to enlighten those stubmling around in the dark like myself.

Special thanks go out to...

• Durairaj Athavan Raja
• Ulli Hoffmann
• Subramanian Venkateswaran
• Eddy De Clercq

So we came down to basically 3 major possibilities for doing this.

• FM: CONVERT_OTF
• FM: CONVERT_ABAPSPOOLJOB_2_PDF
• External Tools

To get started let's create our BSP page.

Page Layout
\ <%@page language="abap" %>\ <%@extension name="htmlb" prefix="htmlb" %>\ <htmlb:content design="design2002" >\   <htmlb:page>\     <htmlb:form method       = "post" \                 encodingType = "multipart/form-data" >\       <htmlb:radioButtonGroup id="display_type" >\         <htmlb:radioButton id   = "inline" \                            text = "Display Inline" />\         <htmlb:radioButton id   = "html" \                            text = "Display Inside HTML Page" />\         <htmlb:radioButton id   = "window" \                            text = "Display In New Window" />\         <htmlb:radioButton id   = "convert" \                            text = "Convert to PDF Inside HTML Page" />\         <htmlb:radioButton id   = "convertnew" \                            text = "Convert System Table List to PDF In New Window" />\         <htmlb:radioButton id   = "convertspool" \                            text = "Convert System Table List to PDF In New Window (SPOOL)" />\       </htmlb:radioButtonGroup>\       <htmlb:fileUpload id          = "myUpload" \                         onUpload    = "HandleUpload" \                         upload_text = "Display" \                         size        = "90" />\       <hr>\       <br>Name = <%= file_name%>\       <br>MIME-Type = <%= file_mime_type%>\       <br>Length = <%= file_length%>\       <% \   IF ( display_type = 'html' OR display_type = 'convert' ) AND  display_url IS NOT INITIAL. \       %>\       <iframe src="<%= display_url%>" _mce_src="/<%= display_url%>" width="100%" height="500px">\       </iframe>\       <% \   ENDIF. \   IF ( display_type = 'window' OR display_type = 'convertnew' ) AND display_url IS NOT INITIAL. \       %>\       <mce:script language="Javascript"><!-- \         window.open("<%= display_url%>").focus(); \        // --></mce:script>\       <% \   ENDIF. \       %>\     </htmlb:form>\   </htmlb:page>\ </htmlb:content>\ \

This is basically the code from Brian's weblog with a couple of new radio options.

Page Attributes

style="width:350px;border:thin inset;background:lightgrey;background-color:lightgrey">\ content\             TYPE\     STRING
display_type\     TYPE\     STRING
display_url\     TYPE\     STRING
file_content\     TYPE\     XSTRING
file_length\     TYPE\     STRING
file_mime_type\     TYPE\     STRING
file_name\     TYPE\     STRING

OnInputProcessing

\ * event handler for checking and processing user input and \ * for defining navigation \  \ DATA: radioButtonGroup TYPE REF TO CL_HTMLB_RADIOBUTTONGROUP. \ DATA: fileUpload TYPE REF TOCL_HTMLB_FILEUPLOAD. \ DATA: cached_response TYPE REF TO if_http_response. \ DATA: response TYPE REF TO if_http_response. \ DATA: guid TYPE guid_32. \  \ fileUpload ?= CL_HTMLB_MANAGER=>GET_DATA( \                        request = request \                        id      = 'myUpload' \                        name    = 'fileUpload' ). \  \ file_name      = fileUpload->file_name. \ file_mime_type = fileUpload->file_content_type. \ file_length    = fileUpload->file_length. \ file_content   = fileUpload->file_content. \  \ radioButtonGroup ?= CL_HTMLB_MANAGER=>GET_DATA( \                        request = request \                        id      = 'display_type' \                        name    = 'radioButtonGroup' ). \  \ display_type = radioButtonGroup->selection. \  \ IF display_type = 'inline' AND XSTRLEN( file_content ) > 0. \   response = runtime->server->response. \   response->set_data( file_content ). \   response->set_header_field( name  = if_http_header_fields=>content_type \                               value = file_mime_type ). \   " response->set_header_field( name  = if_http_header_fields=>content_length \   "                             value = file_length ). \   response->delete_header_field( name = if_http_header_fields=>cache_control ). \   response->delete_header_field( name = if_http_header_fields=>expires ). \   response->delete_header_field( name = if_http_header_fields=>pragma ). \   navigation->response_complete( ). " signal that response is complete \  \   RETURN. \ ENDIF. \  \ IF ( display_type = 'html' OR display_type = 'window' ) AND XSTRLEN( file_content ) > 0. \  \   CREATE OBJECT cached_response TYPE CL_HTTP_RESPONSE EXPORTING add_c_msg = 1. \  \   cached_response->set_data( file_content ). \   cached_response->set_header_field( name  = if_http_header_fields=>content_type \                                      value = file_mime_type ). \   cached_response->set_status( code = 200 reason = 'OK' ). \   cached_response->server_cache_expire_rel( expires_rel = 180 ). \  \   CALL FUNCTION 'GUID_CREATE' \     IMPORTING \       ev_guid_32 = guid. \   CONCATENATE runtime->application_url '/' guid INTO display_url. \  \   cl_http_server=>server_cache_upload( url      = display_url \                                        response = cached_response ). \   RETURN. \  \ ENDIF. \

That there will get all of the normal stuff working that Brian describes in his weblog on dealing with NON-HTML documents.

Now let's go into each of these 3 possibilites and see which one works best for you...

FM: CONVERT_OT

This seems to be the best possible solution; to be honest with you, I like this one. Not sure why but I do. First things first is that you have to create a SmartForm (transaction SMARTFORMS) and once you create the SmartForm just in the menu click ENVIRONMENT - FUNCTION MODULE NAME. You see once you create the SmartForm and activate it it generates a function module.

Let's make a SmartForm

I started by calling transaction SMARTFORMS, there I gave my SmartForm a name and selected "CREATE"

Once created I started to edit the SmartForm, the first step was the Form Interface, I entered my table parameters there.

Then I defined my global variables for the table and the table structure.

Then on the Initalization tab of the Global section I was able to initialize my table.

Then simply click on your Page and you can then create a table element, which then under the data table you define your table LOOP.

Then for test purposes I simply added one cell of data and one text label to the cell, then dragged from my field list box the name of one cell to the new text box.

Once that was all complete I was able to "activate" the SmartForm and then get the function module name from the menu option.

So got your SmartForm? OK, then let's modify our code to add in for that. Go to your OnInputProcessing Event Handler and append this to the bottom of the existing code.

OnInputProcessing

\ IF display_type = 'convert' OR display_type = 'convertnew'. \  \ * generated result: PDF format \   data: l_pdf_xstring  type xstring, \         lt_lines       type table of tline, \         ls_line        type tline, \         l_pdf_len      type i. \  \   data: output_options      type ssfcompop, \         control_parameters  type ssfctrlop, \         output_data         type ssfcrescl, \         devtype             type rspoptype. \  \   data: lt_sys type table of zsystems. \  \   control_parameters-langu = sy-langu. \   control_parameters-no_dialog = 'X'. \   control_parameters-getotf    = 'X'. \  \   select * from zsystems into table lt_sys. \  \   call function 'SSF_GET_DEVICE_TYPE' \     EXPORTING \       i_language             = sy-langu \     IMPORTING \       e_devtype              = devtype \     EXCEPTIONS \       no_language            = 1 \       language_not_installed = 2 \       no_devtype_found       = 3 \       system_error           = 4 \       others                 = 5. \  \ * set device type in output options \   output_options-tdprinter = devtype. \  \   call function '/1BCDWB/SF00000001' \     EXPORTING \       user_settings      = space \       control_parameters = control_parameters \       output_options     = output_options \     IMPORTING \       job_output_info    = output_data \     TABLES \       zsystems           = lt_sys \     EXCEPTIONS \       formatting_error   = 1 \       internal_error     = 2 \       send_error         = 3 \       user_canceled      = 4 \       others             = 5. \  \   call function 'CONVERT_OTF' \     EXPORTING \       format                = 'PDF' \     IMPORTING \       bin_filesize          = l_pdf_len \       bin_file              = l_pdf_xstring \     TABLES \       OTF                   = OUTPUT_DATA-OTFDATA \       LINES                 = LT_LINES \     EXCEPTIONS \       err_max_linewidth     = 1 \       err_format            = 2 \       err_conv_not_possible = 3 \       err_bad_otf           = 4 \       others                = 5. \  \   if sy-subrc EQ 0. \  \     CREATE OBJECT cached_response TYPE CL_HTTP_RESPONSE EXPORTING add_c_msg = 1. \  \     l_pdf_len = xstrlen( l_pdf_xstring ). \     cached_response->set_data( data   = l_pdf_xstring \                         length = l_pdf_len ). \  \     cached_response->set_header_field( name  = if_http_header_fields=>content_type \                                        value = 'application/pdf' ). \     cached_response->set_status( code = 200 reason = 'OK' ). \     cached_response->server_cache_expire_rel( expires_rel = 180 ). \  \     CALL FUNCTION 'GUID_CREATE' \       IMPORTING \         ev_guid_32 = guid. \     CONCATENATE runtime->application_url '/' guid '.pdf' INTO display_url. \  \     cl_http_server=>server_cache_upload( url      = display_url \                                          response = cached_response ). \  \   ENDIF. \  \   RETURN. \  \ ENDIF. \

As you can see we give our now selected table of data to the SmartForm for processing and then the OTF encoded results from the SmartForm to the CONVERT_OTF FM for processing.

Did you try it? Did you get your PDF file like me?

FM: CONVERT_ABAPSPOOLJOB_2_PDF

Raja provided a nice code sample to work with for this option.
\ call function 'GET_PRINT_PARAMETERS' \   EXPORTING \     destination    = loc_dest \     copies         = wf_copies \     list_name      = wf_listname \     list_text      = wf_listtext \     immediately    = ' ' \     release        = ' ' \     new_list_id    = 'X' \     expiration     = wf_days \     line_size      = 200 \     line_count     = 65 \     layout         = 'X_65_200' \     sap_cover_page = 'X' \     receiver       = 'SAP*' \     department     = '' \     no_dialog      = 'X' \   IMPORTING \     out_parameters = wf_params \     valid          = wf_valid. \  \ if wf_valid <> space. \   new-page print on parameters wf_params no dialog. \  \ * using the normal ABAP write statement  \ * write the contents here  \ * (e.g Write:/'This is for testing' \  \   new-page print off. \ endif . \

sy-spono will then contain your Spool number which you can then use with the function module CONVERT_ABAPSPOOLJOB_2_PDF with the Spool number as a parameter. This will return a table, PDF STRUCTURE TLINE, which you can then save with .pdf extension. As Raja pointed out "I havent tried this myself inside a BSP application, but i feel that it should work."

From a logic point of view I will say that since the normal ABAP write statements don't work directly in the BSP you would have to really think hard to figure out how to get this to work. We are now attempting to do just that and will post back with an update to the weblog if we figure it out.

Another option would be if you had the spool number first, for example from a select list or something. You would be as dynamic as with the SmartForm method but it should also work, just gotta convert your PDF table to XSTRING.

\ IF display_type = 'convertspool'. \  \   DATA: itab TYPE TLINE, \         witab TYPE TABLE OF TLINE, \         output TYPE STRING, \         outputx TYPE XSTRING. \  \   call function 'CONVERT_ABAPSPOOLJOB_2_PDF' \     EXPORTING \       SRC_SPOOLID              = 9553 \       NO_DIALOG                = 'X' \     TABLES \       PDF                      = witab \     EXCEPTIONS \       ERR_NO_ABAP_SPOOLJOB     = 1 \       ERR_NO_SPOOLJOB          = 2 \       ERR_NO_PERMISSION        = 3 \       ERR_CONV_NOT_POSSIBLE    = 4 \       ERR_BAD_DESTDEVICE       = 5 \       USER_CANCELLED           = 6 \       ERR_SPOOLERROR           = 7 \       ERR_TEMSEERROR           = 8 \       ERR_BTCJOB_OPEN_FAILED   = 8 \       ERR_BTCJOB_SUBMIT_FAILED = 9 \       ERR_BTCJOB_CLOSE_FAILED  = 10 \       others                   = 11. \  \   if sy-subrc EQ 0. \     LOOP AT witab INTO itab. \       CONCATENATE \         output \         itab-tdline \       INTO output. \     ENDLOOP. \  \ ****Convert the Character String to Binary String \     data: r_string  type string. \     data: R_XSTRING type xstring. \  \     call function 'SCMS_STRING_TO_XSTRING' \       EXPORTING \         text   = output \       IMPORTING \         buffer = outputx. \  \     CREATE OBJECT cached_response TYPE CL_HTTP_RESPONSE EXPORTING add_c_msg = 1. \  \     l_pdf_len = xstrlen( outputx ). \     cached_response->set_data( data   = outputx \                         length = l_pdf_len ). \  \     cached_response->set_header_field( name  = if_http_header_fields=>content_type \                                        value = 'application/pdf' ). \     cached_response->set_status( code = 200 reason = 'OK' ). \     cached_response->server_cache_expire_rel( expires_rel = 180 ). \  \     CALL FUNCTION 'GUID_CREATE' \       IMPORTING \         ev_guid_32 = guid. \     CONCATENATE runtime->application_url '/' guid '.pdf' INTO display_url. \  \     cl_http_server=>server_cache_upload( url      = display_url \                                          response = cached_response ). \  \   ENDIF. \  \   RETURN. \  \ ENDIF. \

I think that should work, we will keep you posted on further developments using this method.

Here is a solution from Raja: SPOOL TO PDF

External Tools

Now there are lots of these tools out there, Eddy points out HTMLDOC. Eddy goes on to tell us that all we have to is

"The way to go is to install HTMLDOC, then make an external command. In your BSP page (with extension pdf, is needed for MIE) make you HTML and write it to temp file. Call the external command with the temp file as input. Then read the pdf and set it as content and set all response headers for pdf. Clean up the temp files. It works good and fast.

There are also JAVA and ActiveX tools out there as well. Each of you will have to decide your own strategy of course. Personally if the system can already do it then why install another component that you may have to worry about compatability issues with in the future?

Where does all this leave us?

So as you can see there are often many possiblities for problems you encounter and it is just a matter of deciding which one works best for you. In this case does it make sense to create a SmartForm for each and every item you want to print out? Perhaps if you have a Corporate Identity that you must adhere to then this could be the best way.

The "spool" seems like a great choice simply because you don't have create a SmartForm first.  In fact a clever person might just have a ABAP report that runs and creates the Spool outputs and then a BSP which lets a person select an existing Spool and then retrieve it as PDF.

External tools are always available and there are lots of them out there, however, you have to ask yourself "Do you really want to add a component that may not be compatible after the next SP or Release?". These are problems that sometimes arise as we move into the future, whereas, an internal solution such as SmartForms or ABAPSPOOL to PDF well those I think will be supported in the future.

Please consider this weblog a work in progress as I don't think we've heard the end of our efforts with ABAP Spool and I'm sure there are quite a few more possible solutions out there and I hope you'll share yours with us as well!

What the future holds!!

From Matthias Zeller, Indeed Interactive Forms is the "next generation" forms tool in SAP (and not only for interactive, but also for print forms). It is available starting with Web AS 6.40. Smart Forms and SAPscript will be continue to be available but all new development around SAP forms will be done in the new Interactive Forms. The Adobe document services (ADS) which are part of Interactive Forms can generate different output including PDF, PS, PCL and ZPL (for Zebra Label printers).
So with Interactive Forms you will be able to generate PDF in an SAP system natively by merging forms data with a form template (so you do not need to create OTF anymore and use the CONVERT_OTF libraries to generate PDF). This can be configured in ABAP using transaction SFP or with Web Dynpro for Java to create PDF documents embedded in a Web UI (and in the future also with Web Dynpro for ABAP).
The PDFs generated with ADS are actually the latest version PDF 1.6 and can be made accessible to blind people via screen readers.

Tips:
From Jonathan Bourne, Just wanted to mention that rather than hunting for the Smartforms function module name the following function module can be used:

SSF_FUNCTION_MODULE_NAME

This FM takes the Smartform name and returns the function module name. This is a more robust solution as the Smartform may receive a different FM name when it is transported to other systems.