Display/Delete attachment from Business transactions using Webdynpro (Java)

[raja_thangamani]

Introduction: This blog describes how to display/delete the documents, which are stored in any SAP Business transactions like MM01, IE01, VA01, FB01 and WTY etc from Webdynpro Java.  

If you have not read the Organize your business attachments from Web & How To: Create attachments in Business Transaction from Webdynpro(Java), I would recommend to read those before you continue this blog.

Let's look at the outcome of this blog before we get into the details.

Note: We will display & delete those documents, which we created in How To: Create attachments in Business Transaction from Webdynpro(Java) of this series blog.

1. Let's say my Material master has 2 attachments as shown below.
   
2. Using this Webdynpro Application we will view/delete those attachments in web.
3. Once you execute the WDJ Application, enter the Object Key Number for which you already created the attachment. In our case Material number is the object key. Click Submit. The list of attachment will be shown as below:
   
4. In order to view the attachment, click on File name (Link), the attachment will be shown in pop as below:
   
5. Let's look at the delete functionality. Select anyone of the line & click on delete button and click 'Yes' for confirmation. 
   
6. You will get the confirmation after successful deletion of document

Let's look at the development steps:

Below is the Java webdynpro application which will look like once you are done with the development:

 

1. Create the webdynpro project say Display_attachment and Application DisplayAttachmentt
2. Import the BAPI which will get the attachment list & details from SAP to webdynpro by right clicking the Model. RFC detail will be explained later in this document.
3. In following screen, choose "Import Adaptive RFC Model" also enter the necessary details 
4. Once Model is imported successfully, add the model into webdynpro component by right clicking "Used Model" as shown below.
   
   
5. Create the view Display_AttachmentView & create the below context node & attributes:
   
6. Node AttachmentList cardinality is 0:n, selection is 0:1
7. Attribute details are below:
   

   Attribute	Type
   Date	date
   Display_Doc	com.sap.ide.webdynpro.uielementdefinitions.Resource
   DocContent	string
   DocName	string
   DocumentID	string
   DocumentType	string
   Material_No	string

8. The layout looks like below:
   
9. Create the Event handler say "submit" and assign it to Submit button. This method will bring the list of attachments from SAP. Below is the code for the same & related methods:
   
   public void onActionsubmit(com.sap.tc.webdynpro.progmodel.api.IWDCustomEvent wdEvent )  {    //@@begin onActionsubmit(ServerEvent)    wdContext.nodeAttachmentList().invalidate(); this.AttachedList();    //@@end  }public void AttachedList( )  {    //@@begin AttachedList()IWDMessageManager msgManager = wdComponentAPI.getMessageManager();IPrivateDisplay_AttachmentView.IAttachmentListNode node =    wdContext.nodeAttachmentList();Zread_Attach_List_Output documentList = this.executeAttachmentList(wdContext.currentContextElement().getMaterial_No());    if (documentList != null) {Iterator attachments = documentList.getAll_Connections().iterator();while (attachments.hasNext()) {     Bdn_Con modelElement = (Bdn_Con) attachments.next();     IPrivateDisplay_AttachmentView.IAttachmentListElement newElement=      node.createAttachmentListElement();     newElement.setDocumentID(modelElement.getLoio_Id());     newElement.setDocName(modelElement.getComp_Id());     newElement.setDocumentType(modelElement.getDocuclass()); String create_dt = modelElement.getCrea_Time().substring(0, 8); try {  SimpleDateFormat dateFormat =new SimpleDateFormat("yyyyMMdd");  java.util.Date date = dateFormat.parse(create_dt);  java.sql.Date sqlDate = new java.sql.Date(date.getTime());  newElement.setDate(sqlDate); }   catch (Exception e) {  e.printStackTrace(); } newElement.setDisplay_Doc("X"); node.addElement(newElement); }}       //@@end}  public com.sap.display_attachment.attacments.Zread_Attach_List_Output executeAttachmentList( )  {    //@@begin executeAttachmentList() Zread_Attach_List_Input bapiInput =    new Zread_Attach_List_Input(WDModelScopeType.TASK_SCOPE);   // Provide input parameters   bapiInput.setClassname("BUS1001006");   bapiInput.setClasstype("BO");   bapiInput.setObjkey(wdContext.currentContextElement().getMaterial_No());   // Execute RFC   try {    bapiInput.execute();    Zread_Attach_List_Output response = bapiInput.getOutput();   } catch (Exception ex) {    wdComponentAPI.getMessageManager().reportException(     ex.getMessage(),     false);   }   return bapiInput.getOutput();    //@@end  }
   
10. Create the event handler say "Displayattachment" and assign into Link (AttachmentList.DocName). This will be used to view the document. Below is the Code for the same:
    public void onActionDisplayattachment(com.sap.tc.webdynpro.progmodel.api.IWDCustomEvent wdEvent )  {    //@@begin onActionDisplayattachment(ServerEvent) IPrivateDisplay_AttachmentView.IAttachmentListElement nodeElements =    wdContext.currentAttachmentListElement(); String url = null; String fileName = null; try {   fileName = wdContext.currentAttachmentListElement().getDocName();   ByteArrayOutputStream boStream =    new ByteArrayOutputStream();   IWDMessageManager msgManager =    wdComponentAPI.getMessageManager();   Zread_Attachment_Input request =    new Zread_Attachment_Input(WDModelScopeType.TASK_SCOPE);   request.setDoc_Id(nodeElements.getDocumentID());   request.execute();   Zread_Attachment_Output response = request.getOutput();   if (response == null) {    throw new Exception("Unable to obtain document details");   }   // Check if this is binary content   if (!response.getContent().isEmpty()) {    Iterator lines = response.getContent().iterator();    while (lines.hasNext()) {    Bapiconten line = (Bapiconten) lines.next();    boStream.write(line.getLine());            }           } else {   // We received no content   throw new Exception("Unable to obtain document contents");   }   if (boStream.size() > 0) {    WDWebResourceType resType =        WDWebResourceType        .getWebResourceTypeForFileExtension(        nodeElements.getDocumentType());                   IWDResource resource =        WDResourceFactory.createCachedResource(        boStream.toByteArray(),        fileName,resType);        url =resource.getUrl(          WDFileDownloadBehaviour.OPEN_INPLACE.ordinal());     }           // Display the attachment in a new window     if (url != null && fileName != null) {       displayAttachment(fileName, url);     }    }     catch (Exception e) {     wdComponentAPI.getMessageManager().reportException(     this.getClass().getName()     + ".displayAttachment:<br /> "     + e.toString(),     false);    }    //@@end  }private void displayAttachment(String fileName, String url) {    IWDWindow newWindow =     wdComponentAPI.getWindowManager().createNonModalExternalWindow(      url,fileName);newWindow.setWindowPosition(WDWindowPos.CENTER);    newWindow.removeWindowFeature(WDWindowFeature.ADDRESS_BAR);newWindow.removeWindowFeature(WDWindowFeature.MENU_BAR);newWindow.removeWindowFeature(WDWindowFeature.TOOL_BAR);newWindow.removeWindowFeature(WDWindowFeature.STATUS_BAR);newWindow.show();}
    
    
11. Create the event handler say "Delete" and assign into "Delete" button.
    
    public void onActionDelete(com.sap.tc.webdynpro.progmodel.api.IWDCustomEvent wdEvent )  {    //@@begin onActionDelete(ServerEvent)     IWDControllerInfo controllerInfo =  wdControllerAPI.getViewInfo().getViewController();    String dialogText = "Are you sure you want to delete the attachment?";  IWDConfirmationDialog dialog =  wdComponentAPI.getWindowManager().createConfirmationWindow(  dialogText,  controllerInfo.findInEventHandlers("Yes"),"Yes");  dialog.addChoice(  controllerInfo.findInEventHandlers("onActionNo"), "No");  dialog.setWindowPosition(WDWindowPos.LEFT);  dialog.setWindowPosition(50,100);  dialog.show();    //@@end  }public void Yes(com.sap.tc.webdynpro.progmodel.api.IWDCustomEvent wdEvent )  {    //@@begin Yes(ServerEvent) IWDMessageManager msgManager = wdComponentAPI.getMessageManager();  IPrivateDisplay_AttachmentView.IAttachmentListNode node =    wdContext.nodeAttachmentList();     Bds_Document_Delete_Input request =new Bds_Document_Delete_Input(      WDModelScopeType.TASK_SCOPE); request.setDoc_Id(wdContext.currentAttachmentListElement().getDocumentID()); try{  request.execute(); } catch(Exception e) { } node.invalidate(); this.AttachedList(); msgManager.reportSuccess("Sucessfully Deleted.");    //@@end  }  public void onActionNo(com.sap.tc.webdynpro.progmodel.api.IWDCustomEvent wdEvent )  {    //@@begin onActionNo(ServerEvent)    //do nothing here    //@@end  } 
12. RFC to get attachment List:
    
    FUNCTION ZREAD_ATTACH_LIST.*"--------------------------------------------------------------------*"*"Local Interface:*"  IMPORTING*"     VALUE(LOGICAL_SYSTEM) TYPE  BAPIBDS01-LOG_SYSTEM OPTIONAL*"     VALUE(CLASSNAME) TYPE  BAPIBDS01-CLASSNAME*"     VALUE(CLASSTYPE) TYPE  BAPIBDS01-CLASSTYPE*"     VALUE(OBJKEY) TYPE  SWOTOBJID-OBJKEY OPTIONAL*"     VALUE(CLIENT) TYPE  SY-MANDT DEFAULT SY-MANDT*"     VALUE(ALL) TYPE  BAPIBDS01-X DEFAULT 'X'*"     VALUE(NO_AL_DOCS) TYPE  BAPIBDS01-X DEFAULT SPACE*"     VALUE(NO_GOS_DOCS) TYPE  BAPIBDS01-X DEFAULT 'X'*"     VALUE(CHECK_STATE) TYPE  BAPIBDS01-X DEFAULT ' '*"  EXPORTING*"     VALUE(COUNT) TYPE  SY-INDEX*"  TABLES*"      SIGNATURE STRUCTURE  BAPISIGNAT OPTIONAL*"      ALL_CONNECTIONS STRUCTURE  BDN_CON*"      FRAMEWORK STRUCTURE  BDN_SELECT OPTIONAL*"  EXCEPTIONS*"      NO_OBJECTS_FOUND*"      ERROR_KPRO*"      INTERNAL_ERROR*"      NOT_AUTHORIZED*"--------------------------------------------------------------------  CALL FUNCTION 'BDS_ALL_CONNECTIONS_GET'    EXPORTING      LOGICAL_SYSTEM   = LOGICAL_SYSTEM      CLASSNAME        = CLASSNAME      CLASSTYPE        = CLASSTYPE      OBJKEY           = OBJKEY      CLIENT           = CLIENT      ALL              = ALL      NO_AL_DOCS       = NO_AL_DOCS      NO_GOS_DOCS      = NO_GOS_DOCS      CHECK_STATE      = CHECK_STATE    IMPORTING      COUNT            = COUNT    TABLES      SIGNATURE        = SIGNATURE      ALL_CONNECTIONS  = ALL_CONNECTIONS      FRAMEWORK        = FRAMEWORK    EXCEPTIONS      NO_OBJECTS_FOUND = 1      ERROR_KPRO       = 2      INTERNAL_ERROR   = 3      NOT_AUTHORIZED   = 4      OTHERS           = 5.  IF SY-SUBRC <> 0.* MESSAGE ID SY-MSGID TYPE SY-MSGTY NUMBER SY-MSGNO*         WITH SY-MSGV1 SY-MSGV2 SY-MSGV3 SY-MSGV4.  ENDIF.ENDFUNCTION.
    
13. Use RFC FM ''BDS_DOCUMENT_GET_TABLE' to display the attachment content.
    
    
    
14. To delete the attachment use RFC "BDS_DOCUMENT_DELETE".

Download: Here is the ready to use Project file Display_attachment.

Hope I covered all the points & add some value to community over here...