Note to Moderator: Request you to kindly DM me if you find any issues with this document.
This document explains how to:
Add Custom XML Parts to Word using ABAP
1. Prepare XML data
METHOD prepare_customxml.
* Exporting EV_CUSTOMXML4DOC TYPE XSTRING
* Exception XSLT_ERROR
* Exporting EV_CUSTOMXML4DOC TYPE XSTRING
* Exception XSLT_ERROR
CONSTANTS: lc_encode TYPE abap_encod VALUE 'UTF-8'.
DATA:
lv_customxml4doc TYPE string,
l_convout TYPE REF TO cl_abap_conv_out_ce,
lv_len TYPE i.
DATA:
lv_customxml4doc TYPE string,
l_convout TYPE REF TO cl_abap_conv_out_ce,
lv_len TYPE i.
l_convout = cl_abap_conv_out_ce=>create( encoding = lc_encode ).
lv_customxml4doc = '<xmlDOC value="This is an example of valid xml" />'. "You can add a valid xml here
l_convout->convert(
EXPORTING
data = lv_customxml4doc
IMPORTING
buffer = ev_customxml4doc
len = lv_len ).
EXPORTING
data = lv_customxml4doc
IMPORTING
buffer = ev_customxml4doc
len = lv_len ).
ENDMETHOD.
2. Get the Word template
The template can be uploaded to the MIME repository and can be read from there.
METHOD get_doc_template.
* Exporting EV_DOC TYPE XSTRING
* Exporting EV_DOC TYPE XSTRING
DATA:
lo_mr_api TYPE REF TO if_mr_api.
lo_mr_api = cl_mime_repository_api=>get_api( ).
lo_mr_api->get(
EXPORTING
i_url = doc_template_url "Give the template url in MIME repository here
IMPORTING
e_content = ev_doc
EXCEPTIONS
OTHERS = 1
).
lo_mr_api->get(
EXPORTING
i_url = doc_template_url "Give the template url in MIME repository here
IMPORTING
e_content = ev_doc
EXCEPTIONS
OTHERS = 1
).
ENDMETHOD.
3. Add Custom XML to Word template
METHOD add_customxml2doc.
* Importing IV_DOC TYPE XSTRING
* Importing IV_CUSTOMXML TYPE XSTRING
* Exporting EV_DOC TYPE XSTRING
* Exception XSLT_ERROR
DATA:
doc TYPE REF TO cl_docx_document,
documentpart TYPE REF TO cl_docx_maindocumentpart,
l_packagecontent TYPE string,
customxmlpartcoll TYPE REF TO cl_openxml_partcollection,
customxmlpart TYPE REF TO cl_oxml_customxmlpart,
customxmlpropspart TYPE REF TOTO cl_oxml_customxmlpropspart,
propertyxml TYPE xstring,
preguid TYPE string,
guid TYPE string.
documentpart TYPE REF TO cl_docx_maindocumentpart,
l_packagecontent TYPE string,
customxmlpartcoll TYPE REF TO cl_openxml_partcollection,
customxmlpart TYPE REF TO cl_oxml_customxmlpart,
customxmlpropspart TYPE REF TOTO cl_oxml_customxmlpropspart,
propertyxml TYPE xstring,
preguid TYPE string,
guid TYPE string.
TRY.
doc = cl_docx_document=>load_document( iv_data = iv_doc ).
l_packagecontent = doc->get_content_type( ).
doc = cl_docx_document=>load_document( iv_data = iv_doc ).
l_packagecontent = doc->get_content_type( ).
* get the maindocument part
documentpart = doc->get_maindocumentpart( ).
* get collection of customXML parts
customxmlpartcoll = documentpart->get_customxmlparts( ).
* create a customXML part here
customxmlpart = documentpart->add_customxmlpart( ).
* insert xml data
customxmlpart->feed_data( iv_customxml ).
* add customXML properties part
customxmlpropspart = customxmlpart->add_customxmlpropspart( ).
* create GUID string
preguid = cl_openxml_helper=>create_guid_string( ).
* enclose with {...} brackets
CONCATENATE '{' preguid '}' INTO guid.
* create custom XML property content
CALL TRANSFORMATION docx_create_custompropscontent
PARAMETERS guid = guid
SOURCE XML iv_customxml
RESULT XML propertyxml.
* insert propertyxml
customxmlpropspart->feed_data( propertyxml ).
ev_doc = doc->get_package_data( ).
documentpart = doc->get_maindocumentpart( ).
* get collection of customXML parts
customxmlpartcoll = documentpart->get_customxmlparts( ).
* create a customXML part here
customxmlpart = documentpart->add_customxmlpart( ).
* insert xml data
customxmlpart->feed_data( iv_customxml ).
* add customXML properties part
customxmlpropspart = customxmlpart->add_customxmlpropspart( ).
* create GUID string
preguid = cl_openxml_helper=>create_guid_string( ).
* enclose with {...} brackets
CONCATENATE '{' preguid '}' INTO guid.
* create custom XML property content
CALL TRANSFORMATION docx_create_custompropscontent
PARAMETERS guid = guid
SOURCE XML iv_customxml
RESULT XML propertyxml.
* insert propertyxml
customxmlpropspart->feed_data( propertyxml ).
ev_doc = doc->get_package_data( ).
CATCH cx_openxml_format.
CATCH cx_openxml_not_allowed.
CATCH cx_openxml_not_found.
CATCH cx_transformation_error.
RAISE xslt_error.
ENDTRY.
CATCH cx_openxml_not_allowed.
CATCH cx_openxml_not_found.
CATCH cx_transformation_error.
RAISE xslt_error.
ENDTRY.
ENDMETHOD.
4. Integrate the above steps - XML, Word template, Custom XML
METHOD get_doc_download.
* Exporting EV_XML_XSTRING_DOC TYPE XSTRING
* Exception ERROR_OCCURRED
* Exception ERROR_OCCURRED
DATA:
lv_customxml4doc TYPE xstring,
lv_doc_template TYPE xstring.
lv_doc_template TYPE xstring.
prepare_customxml(
IMPORTING
ev_customxml4doc = lv_customxml4doc
EXCEPTIONS
xslt_error = 1
OTHERS = 2
).
IF sy-subrc = 1.
RAISE error_occurred.
ELSEIF sy-subrc = 2.
RAISE error_occurred.
ENDIF.
IMPORTING
ev_customxml4doc = lv_customxml4doc
EXCEPTIONS
xslt_error = 1
OTHERS = 2
).
IF sy-subrc = 1.
RAISE error_occurred.
ELSEIF sy-subrc = 2.
RAISE error_occurred.
ENDIF.
get_doc_template(
IMPORTING
ev_doc = lv_doc_template
).
IMPORTING
ev_doc = lv_doc_template
).
add_customxml2doc(
EXPORTING
iv_doc = lv_doc_template
iv_customxml = lv_customxml4doc
IMPORTING
ev_doc = ev_xml_xstring_doc
EXCEPTIONS
xslt_error = 1
OTHERS = 2
).
IF sy-subrc <> 0.
RAISE error_occurred.
ENDIF.
ENDMETHOD.
Related Articles: