Skip to Content
Technical Articles

Best way to generate Microsoft word docx from ABAP

There are several ways to generate Microsoft Word docx documents using ABAP.

All of them have a number of disadvantages:

  • some require a lot of manual actions and saving structures in the ABAP dictionary
  • some require the Microsoft Office package installed on the user’s computer for their work

The advantage of my development:

  • requires a minimum of manual actions
  • works on the server side (does not require the presence of Microsoft Office)

If you know easier way to generate Microsoft Word docx documents – please, notify me.

Metrics for measuring the simplicity (lower is better):

  • mouse click: single click / double click / select = 2 points
  • keyboard type: one word / tab / enter = 1 point
  • switch application / alt + tab = 3 points
  • + cost of change (add 2 fields + remove 2 fields + rename 2 fields)

Source, readme: https://github.com/AntonSikidin/zcl_docx
Video (watch in 1080p):

Instruction and video complement each other.

Installation Install package via ABAPGIT https://docs.abapgit.org/guide-install.html

For example, the following document should be created:

At first toggle developer toolbar in Microsoft Word.
File -> Options -> Customize ribbon.

Go to developer tab, turn on “design mode”.

Select text that will be replaced.

Make tag.

Enter tag name.

 

Repeat for all variable.

For repeated rows or text fragment – select row or text fragment, make repeated control.

To enter properties of repeated control place cursor in the begin or end control.

Tag all variables and repeated part.

Save document. Go to transaction smw0 Select Binary data, enter.

Go to se38 Program ZDOCX_GET_TYPES.

Navigate to your template.

Run.

Program generate data types, based on your document structure.

Copy to your program.

Define variable.

Data
: gs_templ_data TYPE t_data
.

Fill structure with your data.

Then get document.

zcl_docx3=>get_document(
    iv_w3objid    = 'ZDOCX_EXAMLE' " name of our template, obligatory
*      iv_on_desktop = 'X'           " by default save document on desktop
*      iv_folder     = 'report'      " in folder by default 'report'
*      iv_path       = ''            " IF iv_path IS INITIAL  save on desctop or sap_tmp folder
*      iv_file_name  = 'report.docx' " file name by default
*      iv_no_execute = ''            " if filled -- just get document no run office
*      iv_protect    = ''            " if filled protect document from editing, but not protect from sequence
                                   " ctrl+a, ctrl+c, ctrl+n, ctrl+v, edit
    iv_data       = gs_templ_data  " root of our data, obligatory
*      iv_no_save    = ''            " just get binary data not save on disk
    ).

Whole program “ZDOCX_EXAMPLE”:

*&---------------------------------------------------------------------*
*& Report ZDOCX_EXAMPLE
*&---------------------------------------------------------------------*
*&
*&---------------------------------------------------------------------*
REPORT zdocx_example.

*describe types

TYPES
: begin of t_TABLE3
,       PERSON type string
,       SALARY type string
, end of t_TABLE3

, tt_TABLE3 type table of t_TABLE3 with empty key


, begin of t_T2
,       F1 type string
,       F2 type string
,       F3 type string
, end of t_T2

, tt_T2 type table of t_T2 with empty key


, begin of t_T1
,       H1 type string
, T2 type tt_T2
, end of t_T1

, tt_T1 type table of t_T1 with empty key


, begin of t_LINE1
,       FIELD1 type string
,       FIELD2 type string
,       FIELD3 type string
,       FIELD4 type string
, end of t_LINE1

, tt_LINE1 type table of t_LINE1 with empty key


, begin of t_TAB1
,       TITLE1 type string
, LINE1 type tt_LINE1
, end of t_TAB1

, tt_TAB1 type table of t_TAB1 with empty key


, begin of t_LINE2
,       FIELD1 type string
,       FIELD2 type string
,       FIELD3 type string
, end of t_LINE2

, tt_LINE2 type table of t_LINE2 with empty key


, begin of t_TAB2
,       TITLE2 type string
, LINE2 type tt_LINE2
, end of t_TAB2

, tt_TAB2 type table of t_TAB2 with empty key


, begin of t_data
,       SH01 type string
,       DATE type string
,       TIME type string
,       USER type string
, TABLE3 type tt_TABLE3
, T1 type tt_T1
, TAB1 type tt_TAB1
, TAB2 type tt_TAB2
, end of t_data

, tt_data type table of t_data with empty key


.



*some variable
DATA
      : gs_templ_data TYPE t_data
      , lv_index TYPE i
      , lv_index2 TYPE i
      , lv_index3 TYPE i
      .


*fill data

gs_templ_data-DATE = |{ sy-datum date = environment }|.
gs_templ_data-TIME = |{ sy-uzeit   TIME = ENVIRONMENT }|.
gs_templ_data-USER  = sy-uname.


*1.  Lurch Schpellchek: 1200 usd
*2.  Russell Sprout: 1300 usd
*3.  Fergus Douchebag: 3000 usd
*4.  Bartholomew Shoe: 100 usd

APPEND INITIAL LINE TO gs_templ_data-table3 ASSIGNING FIELD-SYMBOL(<ls_3>).
<ls_3>-person = 'Lurch Schpellchek'.
<ls_3>-salary = '1200'.

APPEND INITIAL LINE TO gs_templ_data-table3 ASSIGNING <ls_3>.
<ls_3>-person = 'Russell Sprout'.
<ls_3>-salary = '1300'.

APPEND INITIAL LINE TO gs_templ_data-table3 ASSIGNING <ls_3>.
<ls_3>-person = 'Fergus Douchebag'.
<ls_3>-salary = '3000'.

APPEND INITIAL LINE TO gs_templ_data-table3 ASSIGNING <ls_3>.
<ls_3>-person = 'Bartholomew Shoe'.
<ls_3>-salary = '100'.



gs_templ_data-sh01 = 'test aaa'.

DO 3 TIMES.
  lv_index = sy-index.

  APPEND INITIAL LINE TO gs_templ_data-tab1 ASSIGNING FIELD-SYMBOL(<ls_tab1>).
  <ls_tab1>-title1 = |table 1 subtable { lv_index }|.


  DO 3  TIMES.
    lv_index2 = sy-index.
    APPEND INITIAL LINE TO <ls_tab1>-line1 ASSIGNING FIELD-SYMBOL(<ls_line1>).

    DO 4 TIMES.
      lv_index3 = sy-index.

      ASSIGN COMPONENT lv_index3 OF STRUCTURE <ls_line1> TO FIELD-SYMBOL(<fs_any>).

      <fs_any> = |Line { lv_index2  } field { lv_index3 }|.

    ENDDO.


  ENDDO.


ENDDO.


DO 3 TIMES.
  lv_index = sy-index.

  APPEND INITIAL LINE TO gs_templ_data-tab2 ASSIGNING FIELD-SYMBOL(<ls_tab2>).
  <ls_tab2>-title2 = |Table 2 subtable { lv_index }|.


  DO 3  TIMES.
    lv_index2 = sy-index.
    APPEND INITIAL LINE TO <ls_tab2>-line2 ASSIGNING FIELD-SYMBOL(<ls_line2>).

    DO 3 TIMES.
      lv_index3 = sy-index.

      ASSIGN COMPONENT lv_index3 OF STRUCTURE <ls_line2> TO <fs_any>.

      <fs_any> = |Line { lv_index2  } field { lv_index3 }|.

    ENDDO.


  ENDDO.


ENDDO.

gs_templ_data = VALUE #( BASE gs_templ_data
  t1 = VALUE #(
    ( h1 = |1| t2 = VALUE #(
        ( f1 = 'F1' f2 = 'F2' f3 = 'f3' )
        ( f1 = 'F1' f2 = 'F2' f3 = 'f3' )
      )
    )
    ( h1 = |2| t2 = VALUE #(
        ( f1 = 'F1' f2 = 'F2' f3 = 'f3' )
        ( f1 = 'F1' f2 = 'F2' f3 = 'f3' )
        ( f1 = 'F1' f2 = 'F2' f3 = 'f3' )
      )
    )
    ( h1 = |3| t2 = VALUE #(
        ( f1 = 'F1' f2 = 'F2' f3 = 'f3' )
        ( f1 = 'F1' f2 = 'F2' f3 = 'f3' )
        ( f1 = 'F1' f2 = 'F2' f3 = 'f3' )
        ( f1 = 'F1' f2 = 'F2' f3 = 'f3' )
      )
    )
  )
).


*get document

DATA
       : lv_document TYPE xstring  " variable to hold generated document, can be omitted
       .

*first case:  send document as attachment

lv_document = zcl_docx3=>get_document(
    iv_w3objid    = 'ZDOCX_EXAMLE'
    iv_data       = gs_templ_data
    iv_no_save    = 'X'   ).

PERFORM send_document_as_attachment USING lv_document.



*second case: save on desctop and open document

zcl_docx3=>get_document(
    iv_w3objid    = 'ZDOCX_EXAMLE' " name of our template, obligatory
*      iv_on_desktop = 'X'           " by default save document on desktop
*      iv_folder     = 'report'      " in folder by default 'report'
*      iv_path       = ''            " IF iv_path IS INITIAL  save on desctop or sap_tmp folder
*      iv_file_name  = 'report.docx' " file name by default
*      iv_no_execute = ''            " if filled -- just get document no run office
*      iv_protect    = ''            " if filled protect document from editing, but not protect from sequence
                                   " ctrl+a, ctrl+c, ctrl+n, ctrl+v, edit
    iv_data       = gs_templ_data  " root of our data, obligatory
*      iv_no_save    = ''            " just get binary data not save on disk
    ).


FORM send_document_as_attachment USING iv_doc TYPE xstring.

*  implement sending here
  MESSAGE 'Doc sended' TYPE 'S'.
ENDFORM.

 

Conclusion:

  • Using this development in your daily work you will save your working time.
  • Freed up time you can spend on legacy code refactoring.
  • After reading this post you can think of a way to generate reports better than this.
  • Your boss will notice your progress.
  • You can ask for a bigger salary.
  • Your hair will become clean and silky.
  • Your dog will stop do bad things.
  • You can play the piano again even if you didn’t.
  • People will populate Mars and there will be apple orchards on Mars.
10 Comments
You must be Logged on to comment or reply to a post.
    • Thank you.

      I checked this project.
      The author has done a great job.
      I have something to learn from this project.

      But this project does not solve the main problem: fill out the template with data for the least amount of action.

      Anton

  • Thank you! Very smart way of generating Word documents. Minimal work for the developer. I don’t see how it could be easier.

    Is it possible to:

    • make the tool more “basis”, like CRM_IC_XML_XSTRING2STRING doesn’t exist in ABAP developer editions (if it’s UTF-8, this should work from ABAP 7.02: string = cl_abap_codepage=>convert_from( xstring )),
    • have a Word template stored anywhere instead of forcing the storage in SMW0 (like a new parameter iv_template of type xstring, making iv_w3objid optional),
    • have the option to generate the ABAP types with the comma at the traditional end position so that the Eclipse ADT pretty printer can align the “TYPES”,
    • and make the tool available as an online version instead of ZIP so that other developers can easily propose changes?

    That would be nice if someone proposes the same kind of solution for Excel (that would be easier than abap2xlsx) 😉

    Sandra

    • Thank you, Sandra, for your feedback.
      Your suggestions have been submitted to the master branch.

      There may be some problems when processing Unicode text in national alphabets in a non-Unicode system.

      I will fix it when I see it.

       

      Two years ago i write some patch to the abap2xlsx.

      Since then, the project has gone further in development and my patches are no longer compatible.

      All you need it is add few methods:

      • load_from_smw0 – it is for me, i prefer to store template this way
      • find_row_by_tag – find row index by your tag(some text in the cell for example [ROW1])
      • extract_row – make local copy of row template for further use
      • extract_rows – make local copy of whole table(header, row, subtotal, total)
      • copy_row – insert your local row template
      • del_row -It is obvious
      • write_cell_by_tag – replace text in cell with text [TAG_HERE]
      • some useful tool to adress cell by index instead of AZ12

       

      With these tools you can decompose the template into atoms and assemble in the desired order

      Almost every method returns an index of an added, deleted, found, modified row in order to orientate at least a little in space.

      Anton

      • Really nice, thank you! I will test it and surely propose as an alternative to abap2xlsx. Now let’s see the reaction of the community.