將自訂動作新增至資產清單檢視 add-custom-action-to-the-asset-listing-view
概觀 overview
通信管理解決方案可讓您將自訂動作新增至「管理資產」使用者介面。
您可以為下列項目,將自訂動作新增至「資產清單」檢視:
- 一或多個資產類型或信函
- 在選取單一、多個資產/信函或未選取時執行(動作/命令變為作用中)
此自訂方式以新增「下載一般PDF」命令至「信函」的「資產清單」檢視的案例來示範。 此自訂案例可讓您的使用者下載單一所選信函的一般PDF。
必備條件 prerequisites
若要完成下列案例或類似案例,您需要了解:
- CRX
- JavaScript
- Java
案例:向字母清單用戶介面添加命令以下載普通PDF版本的字母 addcommandtoletters
下列步驟將「下載一般PDF」命令新增至「信函」的「資產清單」檢視,並允許使用者下載所選信函的一般PDF。 搭配適當的程式碼和參數使用這些步驟,您可以為不同資產新增一些其他功能,例如資料字典或文字。
若要自訂通信管理,讓您的使用者下載一般PDF的信函,請完成下列步驟:
-
前往
https://[server]:[port]/[ContextPath]/crx/de並以管理員身分登入。 -
在「應用程式」資料夾中,使用下列步驟建立名為「項目」的資料夾,其路徑/結構類似於位於選取資料夾中的項目資料夾:
-
以滑鼠右鍵按一下 項目 資料夾(位於以下路徑),然後選取 覆蓋節點:
/libs/fd/cm/ma/gui/content/cmassets/jcr:content/body/content/header/items/selection/itemsnote note NOTE 此路徑專用於建立可搭配選取多個資產/信函之一使用的動作。 如果您想要建立可在未選取的情況下運作的動作,則需要為下列路徑建立覆蓋節點,並據以完成其餘步驟: /libs/fd/cm/ma/gui/content/cmassets/jcr:content/body/content/header/items/default/items
-
確定「覆蓋節點」對話方塊有下列值:
路徑: /libs/fd/cm/ma/gui/content/cmassets/jcr:content/body/content/header/items/selection/items
位置: /apps/
匹配節點類型: 已選取
-
按一下 「確定」。資料夾結構會在應用程式資料夾中建立。
按一下 全部儲存.
-
-
在新建立的項目資料夾下,為特定資產中的自訂按鈕/動作新增節點(範例:downloadFlatPDF),使用下列步驟:
-
以滑鼠右鍵按一下 項目 資料夾和選取 建立 > 建立節點.
-
確保「建立節點」對話框具有以下值,然後按一下 確定:
名稱: downloadFlatPDF(或您要為此屬性指定的名稱)
類型: nt:非結構化
-
按一下您建立的新節點(此處為downloadFlatPDF)。 CRX顯示節點的屬性。
-
將下列屬性新增至節點(此處為downloadFlatPDF),然後按一下 全部儲存:
table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 5-row-3 6-row-3 7-row-3 8-row-3 html-authored no-header 名稱 類型 值 和說明 類別 字串 foundation-collection-action foundation-collection-action 字串 {"target":"。cq-manageasset-admin-childpages", "activeSelectionCount":"single","type":"LETTER"}
activeSelectionCount 可為單一或多個,以允許選取要執行自訂動作的單一或多個資產。type 可以是下列項目的一或多個(逗號分隔多個項目):字母、文字、清單、條件、字典
圖示 字串 圖示下載
「通信管理」(Correspondence Management)表徵圖顯示在命令/菜單的左側。 如需不同的可用圖示和設定,請參閱 CoralUI圖示檔案.jcr:primaryType 名稱 nt:unstructured rel 字串 download-flat-pdf-button sling:resourceType 字串 granite/ui/components/endor/actionbar/button text 字串 下載普通PDF(或任何其他標籤)
顯示在「資產清單」介面中的命令標題 字串 下載所選信函的平面PDF(或任何其他標籤/替代文字)
標題是當使用者將游標暫留在自訂命令上時, 「通信管理」所顯示的替代文字。 -
-
在應用程式資料夾中,使用下列步驟建立名為js的資料夾,其路徑/結構類似於位於管理資料夾中的項目資料夾:
-
以滑鼠右鍵按一下 js 資料夾(位於以下路徑),然後選取 覆蓋節點:"
/libs/fd/cm/ma/gui/components/admin/clientlibs/admin/js -
確定「覆蓋節點」對話方塊有下列值:
路徑: /libs/fd/cm/ma/gui/components/admin/clientlibs/admin/js
位置: /apps/
匹配節點類型: 已選取
-
按一下 「確定」。資料夾結構會在應用程式資料夾中建立。 按一下 全部儲存.
-
-
在js資料夾中,使用按鈕的動作處理程式碼,建立名為formaction.js的檔案,步驟如下:
-
以滑鼠右鍵按一下 js 資料夾(位於以下路徑),然後選取 建立>建立檔案:
/apps/fd/cm/ma/gui/components/admin/clientlibs/admin/js將檔案命名為formaction.js。
-
按兩下檔案以在CRX中開啟它。
-
在formaction.js檔案中(在/apps分支下),從formaction.js檔案復製程式碼,位置如下:
/libs/fd/cm/ma/gui/components/admin/clientlibs/admin/js/formaction.js然後在formaction.js檔案(在/apps分支底下)的結尾附加下列程式碼,然後按一下 全部儲存:
code language-none /* Action url for xml file to be added.*/ var ACTION_URL = "/apps/fd/cm/ma/gui/content/commons/actionhandlers/items/letterpdfdownloader.html"; /* File upload handling*/ var fileSelectedHandler = function(e){ if(e && e.target && e.target.value) $(".downloadLetterPDFBtn").removeAttr('disabled'); else $(".downloadLetterPDFBtn").attr('disabled','disabled'); } /*Handing of Download button in pop up.*/ var downloadClickHandler = function(){ $('#downloadLetterPDFDilaog').modal("hide"); var element = $('.foundation-selections-item'); var path = $(element).data("path"); $("#fileUploadForm").attr('action', ACTION_URL + "?letterId="+path).submit(); } /*Click handling on action button.*/ $(document).on("click",'.download-flat-pdf-button',function(e){ $("#uploadSamepledata").val(""); if($('#downloadLetterPDFDilaog').length == 0){ $(document).on("click",".downloadLetterPDFBtn",downloadClickHandler); $(document).on("change","#uploadSamepledata",fileSelectedHandler); $("body").append(downloadLetterPDFDilaog); } $('#downloadLetterPDFDilaog').modal("show"); }); /*Download popup.*/ var downloadLetterPDFDilaog = '<div id="downloadLetterPDFDilaog" class="coral-Modal notice " role="dialog" aria-hidden="true">'+ '<form id="fileUploadForm" method="POST" enctype="multipart/form-data">'+ '<div class="coral-Modal-header">'+ '<h2 class="coral-Modal-title coral-Heading coral-Heading--2" id="modal-header1443020790107-label" tabindex="0">Download Letter as PDF.</h2>'+ '<button type="button" class="coral-MinimalButton coral-Modal-closeButton" data-dismiss="modal">×</button>'+ '</div>'+ '<div class="coral-Modal-body" id="modal-header1443020790107-message" role="document" tabindex="0">'+ '<div class="coral-Modal-message">'+ '<p></p>'+ '</div>'+ '<div class="coral-Modal-uploader">'+ '<p>Select sample data for letter.</p>'+ '<input type="file" id="uploadSamepledata" name="file" accept=".xml" size="70px">'+ '</div>'+ '</div>'+ '</form>'+ '<div class="coral-Modal-footer">'+ '<button type="button" class="coral-Button" data-dismiss="modal">Cancel</button>'+ '<button type="button" class="coral-Button coral-Button--primary downloadLetterPDFBtn" disabled="disabled">Download</button>'+ '</div>'+ '</div>';您在此步驟中新增的程式碼會覆寫libs資料夾下的程式碼,因此請將先前的程式碼複製到/apps分支中的formaction.js檔案。 將程式碼從/libs分支複製到/apps分支,可確保先前的功能也能運作。
上述代碼用於處理在此過程中建立的命令的字母特定操作。 若要處理其他資產的動作,請修改JavaScript程式碼。
-
-
在應用程式資料夾中,使用下列步驟建立名為items的資料夾,其路徑/結構類似於位於actionhandlers資料夾中的items資料夾:
-
以滑鼠右鍵按一下 項目 資料夾(位於以下路徑),然後選取 覆蓋節點:
/libs/fd/cm/ma/gui/content/commons/actionhandlers/items/ -
確定「覆蓋節點」對話方塊有下列值:
路徑: /libs/fd/cm/ma/gui/content/commons/actionhandlers/items/
位置: /apps/
匹配節點類型: 已選取
-
按一下 「確定」。資料夾結構會在應用程式資料夾中建立。
-
按一下 全部儲存.
-
-
在新建立的項目節點下,為特定資產中的自訂按鈕/動作新增節點(範例:letterpdfdownloader),使用下列步驟:
-
按一下右鍵項目資料夾並選擇 建立>建立節點.
-
確保「建立節點」對話框具有以下值,然後按一下 確定:
名稱: letterpdfdownloader(或您要為此屬性指定的名稱)必須是唯一的。 若您在此處使用不同名稱,請在formaction.js檔案的ACTION_URL變數中指定相同的名稱。)
類型: nt:非結構化
-
按一下您建立的新節點(此處為downloadFlatPDF)。 CRX顯示節點的屬性。
-
將下列屬性新增至節點(此處為letterpdfdownloader),然後按一下 全部儲存:
table 0-row-3 1-row-3 名稱 類型 值 sling:resourceType 字串 fd/cm/ma/gui/components/admin/clientlibs/admin
-
-
在以下位置建立名為POST.jsp的檔案,該檔案具有用於操作處理命令的代碼:
/apps/fd/cm/ma/gui/components/admin/clientlibs/admin
-
以滑鼠右鍵按一下 管理員 資料夾(位於以下路徑),然後選取 建立>建立檔案:
/apps/fd/cm/ma/gui/components/admin/clientlibs/admin
將檔案命名為POST.jsp。 (檔案名稱只需POST.jsp。)
-
按兩下 POST.jsp 檔案以在CRX中開啟。
-
將以下代碼添加到POST.jsp檔案中,然後按一下 全部儲存:
此代碼是信函轉譯服務專屬的代碼。 針對任何其他資產,將該資產的Java程式庫新增至此程式碼。 如需AEM Forms API的詳細資訊,請參閱 AEM Forms API.
如需AEM程式庫的詳細資訊,請參閱AEM 元件.
code language-xml /*Import libraries. Here we are downloading letter flat pdf with input xml data so we require letterRender Api. For any other Module functionality we need to first import that library. */ <%@include file="/libs/foundation/global.jsp"%> <!DOCTYPE html lang="en" PUBLIC "-//W3C//DTD XHTML 1.1//EN" "https://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> <%@page import="com.adobe.icc.ddg.api.*"%> <%@page import="com.adobe.icc.dbforms.obj.*"%> <%@page import="com.adobe.icc.render.obj.*" %> <%@page import="com.adobe.icc.services.api.*" %> <%@page import="org.apache.sling.api.resource.*" %> <%@page import="java.io.File" %> <%@page import="java.util.*" %> <%@page import="com.adobe.livecycle.content.appcontext.AppContextManager"%> <%@page import=" com.adobe.icc.dbforms.exceptions.ICCException"%> <%@page import="java.io.InputStream" %> <%@page import="java.io.FileInputStream" %> <%@page import="org.apache.commons.io.IOUtils" %> <%@page session="false" contentType="text/html; charset=utf-8"%> <%@taglib prefix="sling" uri="https://sling.apache.org/taglibs/sling/1.0"%> <%@taglib prefix="cq" uri="https://www.day.com/taglibs/cq/1.0" %> <%@page session="false" contentType="text/html; charset=utf-8"%> <% AppContextManager.setCurrentAppContext("/content/apps/cm"); /*Get letter id sent in js file.*/ String letterId = request.getParameter("letterId"); if(letterId.lastIndexOf("?") != -1) letterId = letterId.substring(0, letterId.indexOf("?")); String fileName = null; String letterName = null; InputStream inputStream = null; /*Get xml file data*/ if (slingRequest.getRequestParameter("file") != null) inputStream = slingRequest.getRequestParameter("file").getInputStream(); if(letterId != null){ String xmlData = null; try{ xmlData = IOUtils.toString(inputStream, "UTF-8"); } catch (Exception e) { log.error("Xml data does not exists."); } /*letter Name from letter letter id.*/ letterName = letterId.substring(letterId.lastIndexOf("/")+1); /*Invoking letter render services API.*/ LetterRenderService letterRenderService = sling.getService(LetterRenderService.class); /*using CM renderLetter api to get pdfbytes.*/ PDFResponseType pdfResponseType= letterRenderService.renderLetter(letterId,xmlData,true,false,false,false); byte[] bytes = null; /*Downloading pdf bytes as pdf.*/ if(pdfResponseType != null && pdfResponseType.getFile() != null){ bytes = pdfResponseType.getFile().getDocument(); /*set the response header to enable download*/ response.setContentType("application/OCTET-STREAM"); response.setHeader("Content-Disposition", "attachment;filename=\"" + letterName + ".pdf\""); response.setHeader("Pragma", "cache"); response.setHeader("Cache-Control", "private"); out.clear(); response.getOutputStream().write(bytes); } } else{ log.error("Letter id does not exists."); } %>
-
使用自訂功能下載一般PDF的信函 download-flat-pdf-of-a-letter-using-the-custom-functionality
新增自訂功能以下載一般PDF的信函後,您可以使用下列步驟來下載所選信函的一般PDF版本:
-
前往
https://[server]:[port]/[ContextPath]/projects.html並登入。 -
選擇 Forms >字母. 通信管理列出系統中可用的信函。
-
按一下 選擇 然後按一下字母加以選取。
-
選擇 更多 > <download flat="" pdf=""> (依照本文指示建立的自訂功能)。 「Download Letter as Tage(下載PDF)」對話框出現。
功能表項目名稱、功能和alt-text是根據 案例:向字母清單用戶介面添加命令以下載普通PDF版本的字母。
-
在「以PDF方式下載信函」對話方塊中,選取您要在PDF中填入資料的相關XML。
note note NOTE 在將信函下載為一般PDF之前,您可以使用 建立報表 選項。
該信作為普通PDF下載到您的電腦。