通信管理解决方案允许您向创建通信用户界面添加自定义操作。
本文档中的情景说明如何在创建通信用户界面中创建按钮,以将信件作为附加到电子邮件的审阅PDF共享。
要完成此方案,您需要满足以下条件:
在创建通信用户界面中添加包含操作的按钮(此处为发送信件供审阅)包括:
转到https://[server]:[port]/[ContextPath]/crx/de
并以管理员身份登录。
在apps文件夹中,创建一个名为defaultApp
的文件夹,其路径/结构与defaultApp文件夹(位于配置文件夹中)类似。 请按照以下步骤创建文件夹:
右键单击以下路径中的defaultApp文件夹,然后选择覆盖节点:
/libs/fd/cm/config/defaultApp/
确保“覆盖节点”对话框具有以下值:
路径: /libs/fd/cm/config/defaultApp/
叠加位置: /apps/
匹配节点类型: 已选中
单击确定。
单击Save All。
复制/apps分支下的acmExtensionsConfig.xml文件(位于/libs分支下)。
转到“/libs/fd/cm/config/defaultApp/acmExtensionsConfig.xml”
右键单击acmExtensionsConfig.xml文件,然后选择Copy。
右键单击位于“/apps/fd/cm/config/defaultApp/”的defaultApp文件夹,然后选择粘贴。
单击Save All。
双击您新在apps文件夹中创建的acmExtensionsConfig.xml的副本。 随即会打开文件进行编辑。
找到以下代码:
<?xml version="1.0" encoding="utf-8"?>
<extensionsConfig>
<modelExtensions>
<modelExtension type="LetterInstance">
<customAction name="Preview" label="loc.letterInstance.preview.label" tooltip="loc.letterInstance.preview.tooltip" styleName="previewButton"/>
<customAction name="Submit" label="loc.letterInstance.submit.label" tooltip="loc.letterInstance.submit.tooltip" styleName="submitButton" permissionName="forms-users"/>
<customAction name="SaveAsDraft" label="loc.letterInstance.saveAsDraft.label" tooltip="loc.letterInstance.saveAsDraft.tooltip" styleName="submitButton" permissionName="forms-users"/>
<customAction name="Close" label="loc.letterInstance.close.label" tooltip="loc.letterInstance.close.tooltip" styleName="closeButton"/>
</modelExtension>
</modelExtensions>
</extensionsConfig>
要发送电子邮件,您可以使用LiveCycleForms Workflow。 在acmExtensionsConfig.xml的modelExtension标记下添加customAction标记,如下所示:
<customAction name="Letter Review" label="Letter Review" tooltip="Letter Review" styleName="" permissionName="forms-users" actionHandler="CM.domain.CCRCustomActionHandler">
<serviceName>Forms Workflow -> SendLetterForReview/SendLetterForReviewProcess</serviceName>
</customAction>
modelExtension标记包含一组customAction子标记,用于配置操作按钮的操作、权限和外观。 以下是customAction配置标记的列表:
名称 | 描述 |
---|---|
name | 要执行的操作的字母数字名称。 此标记的值是必需的,必须是唯一的(在modelExtension标记内),且必须以字母表开头。 |
标签 | 要在操作按钮上显示的标签 |
工具提示 | 按钮的工具提示文本,当用户将鼠标悬停在按钮上时显示该文本。 |
styleName | 应用于操作按钮的自定义样式的名称。 |
permissionName | 仅当用户具有permissionName指定的权限时,才会显示相应的操作。 将permissionName指定为forms-users 时,所有用户都可以访问此选项。 |
actionHandler | 用户单击按钮时调用的ActionHandler类的完全限定名称。 |
除了上述参数之外,还可能有其他与customAction关联的配置。 这些附加配置可通过CustomAction对象提供给处理程序。
名称 | 描述 |
---|---|
serviceName | 如果customAction包含名为serviceName的子标记,则单击相关按钮/链接时,将调用一个进程,该进程的名称由serviceName标记表示。 确保此过程与Letter PostProcess具有相同的签名。 在服务名称中添加“Forms Workflow->”前缀。 |
标记名称中包含cm_前缀的参数 | 如果customAction包含以名称cm_开头的子标记,则在后处理(无论是信件后处理还是由serviceName标记表示的特殊过程)中,这些参数可在删除了cm_前缀的相关标记下的输入XML代码中使用。 |
actionName | 每当发生点击后进程时,提交的XML都会在标记下包含一个特殊标记,该标记名称带有用户操作名称。 |
单击Save All。
ACMExtensionsMessages.properties文件包含“创建通信”用户界面中各个字段的标签和工具提示消息。 要使自定义操作/按钮正常工作,请在/apps分支中复制此文件。
右键单击以下路径中的locale文件夹,然后选择覆盖节点:
/libs/fd/cm/config/defaultApp/locale
确保“覆盖节点”对话框具有以下值:
路径: /libs/fd/cm/config/defaultApp/locale
叠加位置: /apps/
匹配节点类型: 已选中
单击确定。
单击Save All。
右键单击以下文件并选择Copy:
/libs/fd/cm/config/defaultApp/locale/ACMExtensionsMessages.properties
右键单击以下路径中的locale文件夹,然后选择粘贴:
/apps/fd/cm/config/defaultApp/locale/
ACMExtensionsMessages.properties文件将复制在区域设置文件夹中。
要将新添加的自定义操作/按钮的标签本地化,请在/apps/fd/cm/config/defaultApp/locale/
中为相关区域设置创建ACMExtensionsMessages.properties文件。
例如,要本地化本文中创建的自定义操作/按钮,请创建一个名为ACMExtensionsMessages_fr.properties的文件,并包含以下条目:
loc.letterInstance.letterreview.label=Revue De Lettre
同样,您也可以在此文件中添加更多属性,如工具提示和样式。
单击Save All。
在进行每次服务器端更改后,重新启动Adobe资产编辑器构建基块包。 在此方案中,服务器端的acmExtensionsConfig.xml和ACMExtensionsMessages.properties文件会进行编辑,因此Adobe资产编辑器构建基块包需要重新启动。
您可能需要清除浏览器缓存。
转到 https://[host]:[port]/system/console/bundles
. 如有必要,请以管理员身份登录。
找到Adobe资产编辑器构建基块包。 重新启动包:单击停止,然后单击开始。
重新启动Adobe资产编辑器构建基块包后,自定义按钮会显示在创建通信用户界面中。 您可以在创建通信用户界面中打开信件以预览自定义按钮。
默认情况下,“创建通信”用户界面在cm.domain.js文件中的以下位置实施了ActionHandler:
/libs/fd/cm/ccr/gui/components/admin/clientlibs/ccr/js/cm.domain
对于自定义操作处理,请在CRX的/apps分支中创建cm.domain.js文件的叠加。
在单击操作/按钮时处理操作/按钮包括以下逻辑:
转到 https://[server]:[port]/[ContextPath]/crx/de
. 如有必要,请以管理员身份登录。
在apps文件夹中,在CRX的/apps分支中创建一个名为js
的文件夹,其结构与以下文件夹类似:
/libs/fd/cm/ccr/gui/components/admin/clientlibs/ccrui/js
请按照以下步骤创建文件夹:
右键单击以下路径中的js文件夹,然后选择覆盖节点:
/libs/fd/cm/ccr/gui/components/admin/clientlibs/ccrui/js
确保“覆盖节点”对话框具有以下值:
路径: /libs/fd/cm/ccr/gui/components/admin/clientlibs/ccrui/js
叠加位置: /apps/
匹配节点类型: 已选中
单击确定。
单击Save All。
在js文件夹中,使用用于按钮操作处理的代码创建一个名为ccrcustomization.js的文件,步骤如下:
右键单击以下路径中的js文件夹,然后选择创建>创建文件:
/apps/fd/cm/ccr/gui/components/admin/clientlibs/ccrui/js
将文件命名为ccrcustomization.js。
双击ccrcustomization.js文件以在CRX中将其打开。
在文件中,粘贴以下代码,然后单击Save All:
/* for adding and handling custom actions in Extensible Toolbar.
* One instance of handler will be created for each action.
* CM.domain.CCRCustomActionHandler is actionHandler class.
*/
var CCRCustomActionHandler;
CCRCustomActionHandler = CM.domain.CCRCustomActionHandler = new Class({
className: 'CCRCustomActionHandler',
extend: CCRDefaultActionHandler,
construct : function(action,model){
}
});
/**
* Called when user user click an action
* @param extraParams additional arguments that may be passed to handler (For future use)
*/
CCRCustomActionHandler.prototype.handleAction = function(extraParams){
if (this.action.name == CCRCustomActionHandler.SEND_FOR_REVIEW) {
var sendForReview = function(){
var serviceName = this.action.actionConfig["serviceName"];
var inputParams = {};
inputParams["dataXML"] = this.model.iccData.data;
inputParams["letterId"] = this.letterVO.id;
inputParams["letterName"] = this.letterVO.name;
inputParams["mailId"] = $('#email').val();
/*function to invoke the LivecyleService */
ServiceDelegate.callJSONService(this,"lc.icc.renderlib.serviceInvoker.json","invokeProcess",[serviceName,inputParams],this.onProcessInvokeComplete,this.onProcessInvokeFail);
$('#ccraction').modal("hide");
}
if($('#ccraction').length == 0){
/*For first click adding popup & setting letterName.*/
$("body").append(popUp);
$("input[id*='letterName']").val(this.letterVO.name);
$(document).on('click',"#submitLetter",$.proxy( sendForReview, this ));
}
$('#ccraction').modal("show");
}
};
/**
* Should the action be enabled in toolbar
* @param extraParams additional arguements that may be passed to handler (For future use)
* @return flag indicating whether the action should be enabled
*/
CCRCustomActionHandler.prototype.actionEnabled = function(extraParams){
/*can be customized as per user requirement*/
return true;
};
/**
* Should the action be visible in toolbar
* @param extraParams additional arguments that may be passed to handler (For future use)
* @return flag indicating whether the action should be enabled
*/
CCRCustomActionHandler.prototype.actionVisible = function(extraParams){
/*Check can be enabled for Non-Preview Mode.*/
return true;
};
/*SuccessHandler*/
CCRCustomActionHandler.prototype.onProcessInvokeComplete = function(response) {
ErrorHandler.showSuccess("Letter Sent for Review");
};
/*FaultHandler*/
CCRCustomActionHandler.prototype.onProcessInvokeFail = function(event) {
ErrorHandler.showError(event.message);
};
CCRCustomActionHandler.SEND_FOR_REVIEW = "Letter Review";
/*For PopUp*/
var popUp = '<div class="modal fade" id="ccraction" tabindex="-1" role="dialog" aria-hidden="true">'+
'<div class="modal-dialog modal-sm">'+
'<div class="modal-content">' +
'<div class="modal-header">'+
'<button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">×</span></button>'+
'<h4 class="modal-title"> Send Review </h4>'+
'</div>'+
'<div class="modal-body">'+
'<form>'+
'<div class="form-group">'+
'<label class="control-label">Email Id</label>'+
'<input type="text" class="form-control" id="email">'+
'</div>'+
'<div class="form-group">'+
'<label class="control-label">Letter Name</label>'+
'<input id="letterName" type="text" class="form-control" readonly>'+
'</div>'+
'<div class="form-group">'+
'<input id="letterData" type="text" class="form-control hide" readonly>'+
'</div>'+
'</form>'+
'</div>'+
'<div class="modal-footer">'+
'<button type="button" class="btn btn-default" data-dismiss="modal"> Cancel </button>'+
'<button type="button" class="btn btn-primary" id="submitLetter"> Submit </button>'+
'</div>'+
'</div>'+
'</div>'+
'</div>';
在此方案中,请启用以下组件,这些组件是附加的components.zip文件的一部分:
DSCSample.jar
)SendLetterForReview.lca
)下载并解压缩components.zip
文件,以获取DSCSample.jar
和SendLetterForReview.lca
文件。 按照以下过程中指定的使用这些文件。
仅当您处于“ OSGI设置中,并且要实施的自定义类型需要LC集成时,才需要执行此步骤。
LCA进程在LiveCycle服务器上运行,需要服务器地址和登录凭据。
转到https://[server]:[port]/system/console/configMgr
并以管理员身份登录。
找到AdobeLiveCycle客户端SDK配置,然后单击编辑(编辑图标)。 此时会打开“配置”面板。
输入以下详细信息,然后单击Save:
启用电子邮件服务流程所需的LiveCycle流程。
要查看此流程的功能或创建您自己的类似流程,您需要Workbench。
以管理员身份登录到位于https:/[lc server]/:[lc port]/adminui
的Livecycle Server adminui。
导航到主页>服务>应用程序和服务>应用程序管理。
如果SendLetterForReview应用程序已存在,请跳过此过程中的其余步骤,否则请继续执行后续步骤。
单击导入。
单击选择文件,然后选择SendLetterForReview.lca。
单击预览。
选择在导入完成时将资产部署到运行时。
单击导入。
在AEM服务器中提及要访问AEM服务器的LiveCycle服务。
以管理员身份登录到https:/[host]/:[port]/system/console/configMgr
。
找到并单击AdobeLiveCycle客户端SDK配置。 出现“AdobeLiveCycle客户端SDK配置”面板。
在“服务名称”列表中,单击+图标,然后添加serviceName SendLetterForReview/SendLetterForReviewProcess。
单击保存。
在此方案中,为使通信管理能够发送电子邮件,请在LiveCycle服务器中配置电子邮件服务。
使用管理员凭据登录到位于https:/[lc server]:[lc port]/adminui
的Livecycle Server adminui。
导航到主页>服务>应用程序和服务>服务管理。
找到并单击EmailService。
在SMTP主机中,配置电子邮件服务。
单击保存。
要使用通信管理API,请下载DSCSample.jar
(作为components.zip
的一部分附加在本文档中)并将其上载到LiveCycle服务器。 将DSCSample.jar
文件上传到LiveCycle服务器后,AEM服务器会使用DSCSample.jar
文件访问renderLetter API。
有关更多信息,请参阅将AEM Forms与AdobeLiveCycle连接。
在DSCSample.jar
的cmsa.properties中更新AEM服务器URL,该URL位于以下位置:
DSCSample.jar\com\adobe\livecycle\cmsa.properties
在配置文件中提供以下参数:
每次在服务器端进行任何更改时,请重新启动服务器。
DSCSample.jar
文件使用renderLetter
API。 有关renderLetter API的更多信息,请参阅Interface LetterRenderService。
DSCSample.jar
文件使用API renderLetter
从C作为输入的XML数据中将字母渲染为PDF字节。有关renderLetter和其他API的更多信息,请参阅Letter Render Service。
启动Workbench并登录。
选择窗口>显示视图>组件。 将“组件”视图添加到Workbench ES2。
右键单击组件并选择安装组件。
通过文件浏览器选择DSCSample.jar
文件,然后单击打开。
右键单击RenderWrapper并选择启动组件。 如果组件启动,则组件名称旁边会显示一个绿色箭头。
在配置了用于发送信件以供审阅的操作和按钮后:
清除浏览器缓存。
在创建通信UI中,单击信件审阅并指定审阅人的电子邮件ID。
单击Submit。
审阅人从系统中收到一封包含信件的电子邮件,作为PDF附件。