Playing with SAP Business Document Service

[Former Member]

SAP Business Document Service (BDS) is an easy-to-integrate document management component in the R/3 Basis System. The global class CL_BDS_DOCUMENT_SET contains the most important methods for easy document handling, such as Create, Display, Change, and Delete, and for creating different content, language, and format versions. BDS doesn’t require customization and can be used out of the box with default settings. However, if you have additional requirements such as special document attributes, a transport connection, or the use of external storage systems, you can customize BDS and its infrastructure, the SAP Knowledge Provider, to accommodate them.

Business Document Navigator is a universal document navigation tool used within business knowledge management frameworks, including BDS and the SAP ArchiveLink framework, to find, display, and process documents. BDN requires no customization and features the Enjoy SAP interface. SAP ArchiveLink is a specialized document management functionality that provides an API to an external content server and is optimized to handle large amounts of documents such as incoming invoices, print lists, and outgoing purchase orders.

In this blog I would like to demonstrate a small example that can be used to upload documents into the BDS and display the documents using the Business Document Navigator.

REPORT  zdocument_mgmt.TABLES: sscrfields.TYPE-POOLS : sbdst.CONSTANTS :c_x TYPE xfeld VALUE 'X'.DATA: it_tab TYPE filetable,      wa_tab TYPE file_table,      gv_subrc TYPE i,      ob_document_set TYPE REF TO cl_bds_document_set.SELECTION-SCREEN BEGIN OF BLOCK b1 WITH FRAME TITLE text-001.PARAMETERS :p_clname  TYPE sbdst_classname                  MODIF ID m1 OBLIGATORY,p_ctype   TYPE sbdst_classtype DEFAULT 'OT'     MODIF ID m1 OBLIGATORY,p_clnt    TYPE sbdst_client    DEFAULT sy-mandt MODIF ID m1 OBLIGATORY,p_file    TYPE localfile                        MODIF ID m1.SELECTION-SCREEN BEGIN OF BLOCK b2.SELECTION-SCREEN BEGIN OF LINE.SELECTION-SCREEN PUSHBUTTON 2(20) but USER-COMMAND disp.SELECTION-SCREEN PUSHBUTTON 22(20) but1 USER-COMMAND upload.SELECTION-SCREEN END OF LINE.SELECTION-SCREEN END OF BLOCK b2.SELECTION-SCREEN END OF BLOCK b1.AT SELECTION-SCREEN ON VALUE-REQUEST FOR p_file.  REFRESH: it_tab[].  CALL METHOD cl_gui_frontend_services=>file_open_dialog    EXPORTING      window_title      = 'Select File'      initial_directory = 'C'    CHANGING      file_table        = it_tab      rc                = gv_subrc.  READ TABLE it_tab INTO wa_tab INDEX 1.  IF NOT wa_tab IS INITIAL.    p_file = wa_tab-filename.  ELSE.    MESSAGE s000(0k) WITH 'Please enter valid file name'(001).    STOP.  ENDIF.AT SELECTION-SCREEN.  FREE ob_document_set.  IF sscrfields-ucomm = 'DISP'.    SUBMIT bdsfind_1 WITH classn = p_clname                     WITH classtyp   = p_ctype AND RETURN.  ELSE.    IF NOT p_file IS INITIAL.      PERFORM zf_add_document_to_bds.    ENDIF.  ENDIF.INITIALIZATION.  but = 'Display Documents'.  but1 = 'Upload Document'.START-OF-SELECTION.*&---------------------------------------------------------------------**&      zf_add_document_to_BDS*&---------------------------------------------------------------------*FORM zf_add_document_to_bds .  DATA :  lt_signature   TYPE STANDARD TABLE OF bapisignat,  lt_signature1  TYPE STANDARD TABLE OF bapisignat,  lwa_signature  TYPE bapisignat,  lwa_signature1 TYPE bapisignat,  lv_doc_count   TYPE bds_dcount,  lv_docversion  TYPE bds_dverno,  lv_docvarid    TYPE bds_dvarid,  lt_files       TYPE TABLE OF bapifiles,  lt_files1      TYPE TABLE OF bapifiles,  lwa_files      TYPE bapifiles,  lv_objkey      TYPE sbdst_object_key,  lv_dir         TYPE string,  lv_file        TYPE string,  lt_popli       TYPE STANDARD TABLE OF spopli,  lwa_popli      TYPE spopli,  lv_ans,  lv_new_version TYPE sbdst_doc_ver_no.*Split the file entered in directory and path  CLEAR : lv_dir,lv_file.  CALL FUNCTION 'SO_SPLIT_FILE_AND_PATH'    EXPORTING      full_name     = p_file    IMPORTING      stripped_name = lv_file      file_path     = lv_dir    EXCEPTIONS      x_error       = 1      OTHERS        = 2.  CLEAR:lt_popli,lwa_popli.  lwa_popli-selflag = 'X'.  lwa_popli-varoption = 'Create a new version'.  APPEND lwa_popli TO lt_popli.  IF ob_document_set IS INITIAL.    CREATE OBJECT ob_document_set.    CLEAR : lt_signature,lwa_signature,lt_files,lwa_files,            lv_doc_count,lv_docvarid,lv_docvarid.*Check if the file is existing    lwa_files-directory      = lv_dir.    lwa_files-filename       = lv_file.    APPEND lwa_files TO lt_files.    CALL METHOD cl_bds_document_set=>get_with_files      EXPORTING        classname       = p_clname        classtype       = p_ctype        client          = p_clnt      CHANGING        files           = lt_files        signature       = lt_signature      EXCEPTIONS        nothing_found   = 1        error_kpro      = 2        internal_error  = 3        parameter_error = 4        not_authorized  = 5        not_allowed     = 6        OTHERS          = 7.    READ TABLE lt_signature INTO lwa_signature     WITH KEY prop_value = lv_file.    IF sy-subrc EQ 0.      CLEAR : lt_signature1,lwa_signature1.      LOOP AT lt_signature INTO lwa_signature      WHERE prop_value = lv_file.        MOVE-CORRESPONDING lwa_signature TO lwa_signature1.        APPEND lwa_signature1 TO lt_signature1.      ENDLOOP.      SORT lt_signature1 BY doc_ver_no DESCENDING.      READ TABLE lt_signature1 INTO lwa_signature1 INDEX 1.      lwa_signature = lwa_signature1.*File is existing so create a new version      CALL FUNCTION 'POPUP_TO_DECIDE_LIST'        EXPORTING          textline1          = 'File already existing'          titel              = 'File already existing'        IMPORTING          answer             = lv_ans        TABLES          t_spopli           = lt_popli        EXCEPTIONS          not_enough_answers = 1          too_much_answers   = 2          too_much_marks     = 3          OTHERS             = 4.      IF lv_ans NE 'A'.        CLEAR lt_files.        lwa_files-directory      = lv_dir.        lwa_files-filename       = lv_file.        APPEND lwa_files TO lt_files.        CALL METHOD cl_bds_document_set=>create_version_with_files          EXPORTING            classname       = p_clname            classtype       = p_ctype            client          = p_clnt            doc_id          = lwa_signature-doc_id            doc_ver_no      = lwa_signature-doc_ver_no            doc_var_id      = lwa_signature-doc_var_id          IMPORTING            new_doc_ver_no  = lv_new_version          CHANGING            files           = lt_files          EXCEPTIONS            error_kpro      = 1            internal_error  = 2            nothing_found   = 3            not_authorized  = 4            not_allowed     = 5            parameter_error = 6            OTHERS          = 7.        IF NOT lv_new_version IS INITIAL.          MESSAGE i000(0k) WITH 'New version'                                 lv_new_version                                 'created for file'                                 lv_file.        ENDIF.      ELSE.*File is not existing create a new file        lwa_signature-doc_count   = '1'.        lwa_files-doc_count       = lwa_signature-doc_count.        lwa_signature-comp_count  = '1'.        lwa_signature-doc_ver_no  = '1'.        lwa_signature-doc_var_id  = '1'.        lwa_signature-prop_name   = 'FILE_NAME'.        lwa_signature-prop_value  = lv_file.        APPEND lwa_signature TO lt_signature1.        lwa_files-directory      = lv_dir.        lwa_files-filename       = lv_file.        APPEND lwa_files TO lt_files1.        CALL METHOD cl_bds_document_set=>create_with_files          EXPORTING            classname       = p_clname            classtype       = p_ctype            client          = p_clnt          CHANGING            files           = lt_files1            object_key      = lv_objkey            signature       = lt_signature1          EXCEPTIONS            internal_error  = 1            error_kpro      = 2            parameter_error = 3            not_allowed     = 4            not_authorized  = 5            nothing_found   = 6            OTHERS          = 7.        IF NOT lv_objkey IS INITIAL.          MESSAGE i000(0k) WITH 'File' lv_file                           'Uploaded in BDS Class'                           p_clname.        ENDIF.      ENDIF.    ELSE.*No files exist under this class so create a new file      lwa_signature-doc_count   = '1'.      lwa_files-doc_count       = lwa_signature-doc_count.      lwa_signature-comp_count  = '1'.      lwa_signature-doc_ver_no  = '1'.      lwa_signature-doc_var_id  = '1'.      lwa_signature-prop_name = 'DESCRIPTION'.      lwa_signature-prop_value = lv_file.      APPEND lwa_signature TO lt_signature1.      lwa_files-directory      = lv_dir.      lwa_files-filename       = lv_file.      APPEND lwa_files TO lt_files1.      CALL METHOD cl_bds_document_set=>create_with_files        EXPORTING          classname       = p_clname          classtype       = p_ctype          client          = p_clnt        CHANGING          files           = lt_files1          object_key      = lv_objkey          signature       = lt_signature1        EXCEPTIONS          internal_error  = 1          error_kpro      = 2          parameter_error = 3          not_allowed     = 4          not_authorized  = 5          nothing_found   = 6          OTHERS          = 7.      IF NOT lv_objkey IS INITIAL.        MESSAGE i000(0k) WITH 'File' lv_file                         'Uploaded in BDS Class'                         p_clname.      ENDIF.    ENDIF.  ENDIF.ENDFORM.                    " zf_add_document