topic Using wf-email.htmll template from JS in Alfresco Archive

Using wf-email.htmll template from JS

dranakan — Thu, 15 Dec 2011 08:35:48 GMT

Hello,I want to use the template wf-email.html.ftl but I don't know how to specify the $shareUrl (and other var). How can I define $shareUrl, $productName, …Code to send the mail with template var mail = actions.create("mail"); mail.parameters.to = "me@custom.ch"; mail.parameters.subject = "Test

Re: Using wf-email.htmll template from JS

lukasz_turakiew — Sat, 17 Dec 2011 22:38:35 GMT

Hi,

Please try the following code:


var mail = actions.create("mail");
// This needs to be changed
mail.parameters.to = "receiver_email@some.domain";
mail.parameters.subject = "Test subject";
mail.parameters.template = companyhome.childByNamePath("Data Dictionary/Email Templates/Workflow Notification/wf-email.html.ftl");

var templateArgs = new Array();
templateArgs['workflowTitle'] = "workflowTitle";
templateArgs['workflowPooled'] = true;
templateArgs['workflowDescription'] = "workflowDesc";
templateArgs['workflowId'] = "workflowId";

var templateModel = new Array();
templateModel['args'] = templateArgs;

mail.parameters.template_model = templateModel;

// The node identifier needs to be changed
mail.execute(search.findNode("workspace://SpacesStore/9e15aaac-b30b-4266-984f-21fe273a6113"));
‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍

Although it is possible to use wf-email.html.ftl in such a way, it is not necessarily the way how it should be used.

Best regards,
Lukasz Turakiewicz

Re: Using wf-email.htmll template from JS

dranakan — Mon, 19 Dec 2011 07:33:21 GMT

Thank you Lukasz 🙂 It's working 🙂

Do you use the i18n ? (how can I select the wf-email.html_fr.ftl depending the browser langage ?)

Re: Using wf-email.htmll template from JS

lukasz_turakiew — Mon, 19 Dec 2011 19:08:38 GMT

You could read 'Accept-Language' header:


var acceptLanguage = headers["accept-language"];
‍‍‍

and depending on its value choose an appropriate template - however it seems that it is not the smartest solution for this issue

Regards,
Lukasz Turakiewicz

Re: Using wf-email.htmll template from JS

dranakan — Tue, 20 Dec 2011 08:02:58 GMT

You could read 'Accept-Language' header:
var acceptLanguage = headers["accept-language"];
‍‍‍
and depending on its value choose an appropriate template - however it seems that it is not the smartest solution for this issue

Thank you Lukasz.

I can get the value of my browser if the code is inside a Webscript (Javascript code), but it's not working inside workflow (Javascript code) : headers is not defined. Do I add something ?

Workflow (activiti, Alfresco 4.0b)


…
<userTask id="modifyReview1" name="Validation 1"
                        activiti:assignee="${sgfwf_assignee1.properties.userName}"
                        activiti:formKey="sgfwf:modifyReviewTaskReviewByBoss3">
                        <extensionElements>
                                <activiti:taskListener event="create"
                                        class="org.alfresco.repo.workflow.activiti.tasklistener.ScriptTaskListener">
                                        <activiti:field name="script">
                                                <activiti:string>
                                                       var acceptLanguage = headers["accept-language"];
                                                        logger.debug("Language : "+acceptLanguage);

‍‍‍‍‍‍‍‍‍‍‍‍‍‍

Error log


org.activiti.engine.ActivitiException: Exception while invoking TaskListener: Exception while invoking TaskListener: 11200026 Failed to execute supplied script: 11200025 ReferenceError: "headers" is not defined. (AlfrescoJS#4)
        at org.activiti.engine.impl.persistence.entity.TaskEntity.fireEvent(TaskEntity.java:516)
        at org.activiti.engine.impl.bpmn.behavior.UserTaskActivityBehavior.execute(UserTaskActivityBehavior.java:70)
        at org.activiti.engine.impl.pvm.runtime.AtomicOperationActivityExecute.execute(AtomicOperationActivityExecute.java:40)
        at org.activiti.engine.impl.interceptor.CommandContext.performOperation(CommandContext.java:76)
        at org.activiti.engine.impl.persistence.entity.ExecutionEntity.performOperation(ExecutionEntity.java:481)
        at org.activiti.engine.impl.pvm.runtime.AtomicOperationTransitionNotifyListenerStart.eventNotificationsCompleted(AtomicOperationTransitionNotifyListenerStart.java:48)
        at org.activiti.engine.impl.pvm.runtime.AbstractEventAtomicOperation.execute(AbstractEventAtomicOperation.java:52)
        at org.activiti.engine.impl.interceptor.CommandContext.performOperation(CommandContext.java:76)
        at org.activiti.engine.impl.persistence.entity.ExecutionEntity.performOperation(ExecutionEntity.java:481)
        at org.activiti.engine.impl.pvm.runtime.AbstractEventAtomicOperation.execute(AbstractEventAtomicOperation.java:45)
        at org.activiti.engine.impl.interceptor.CommandContext.performOperation(CommandContext.java:76)
        at org.activiti.engine.impl.persistence.entity.ExecutionEntity.performOperation(ExecutionEntity.java:481)
        at org.activiti.engine.impl.pvm.runtime.AtomicOperationTransitionCreateScope.execute(AtomicOperationTransitionCreateScope.java:44)
        at org.activiti.engine.impl.interceptor.CommandContext.performOperation(CommandContext.java:76)
        at org.activiti.engine.impl.persistence.entity.ExecutionEntity.performOperation(ExecutionEntity.java:481)
        at org.activiti.engine.impl.pvm.runtime.AtomicOperationTransitionNotifyListenerTake.execute(AtomicOperationTransitionNotifyListenerTake.java:61)
        at org.activiti.engine.impl.interceptor.CommandContext.performOperation(CommandContext.java:76)
        at org.activiti.engine.impl.persistence.entity.ExecutionEntity.performOperation(ExecutionEntity.java:481)
        at org.activiti.engine.impl.pvm.runtime.AtomicOperationTransitionDestroyScope.execute(AtomicOperationTransitionDestroyScope.java:111)
        at org.activiti.engine.impl.interceptor.CommandContext.performOperation(CommandContext.java:76)
        at org.activiti.engine.impl.persistence.entity.ExecutionEntity.performOperation(ExecutionEntity.java:481)
        at org.activiti.engine.impl.pvm.runtime.AtomicOperationTransitionNotifyListenerEnd.eventNotificationsCompleted(AtomicOperationTransitionNotifyListenerEnd.java:36)
        at org.activiti.engine.impl.pvm.runtime.AbstractEventAtomicOperation.execute(AbstractEventAtomicOperation.java:52)
        at org.activiti.engine.impl.interceptor.CommandContext.performOperation(CommandContext.java:76)
        at org.activiti.engine.impl.persistence.entity.ExecutionEntity.performOperation(ExecutionEntity.java:481)
        at org.activiti.engine.impl.pvm.runtime.AbstractEventAtomicOperation.execute(AbstractEventAtomicOperation.java:45)
        at org.activiti.engine.impl.interceptor.CommandContext.performOperation(CommandContext.java:76)
…
    at org.mozilla.javascript.NativeJavaMethod.call(NativeJavaMethod.java:243)
        at org.mozilla.javascript.optimizer.OptRuntime.callN(OptRuntime.java:86)
        at org.mozilla.javascript.gen.c9._c1(file:/opt/alfresco-4.0.b/tomcat/webapps/alfresco/WEB-INF/classes/alfresco/templates/webscripts/org/alfresco/repository/forms/form.post.json.js:57)
        at org.mozilla.javascript.gen.c9.call(file:/opt/alfresco-4.0.b/tomcat/webapps/alfresco/WEB-INF/classes/alfresco/templates/webscripts/org/alfresco/repository/forms/form.post.json.js)
        at org.mozilla.javascript.optimizer.OptRuntime.callName0(OptRuntime.java:108)
        at org.mozilla.javascript.gen.c9._c0(file:/opt/alfresco-4.0.b/tomcat/webapps/alfresco/WEB-INF/classes/alfresco/templates/webscripts/org/alfresco/repository/forms/form.post.json.js:90)
        at org.mozilla.javascript.gen.c9.call(file:/opt/alfresco-4.0.b/tomcat/webapps/alfresco/WEB-INF/classes/alfresco/templates/webscripts/org/alfresco/repository/forms/form.post.json.js)
        at org.mozilla.javascript.ContextFactory.doTopCall(ContextFactory.java:393)
        at org.mozilla.javascript.ScriptRuntime.doTopCall(ScriptRuntime.java:2834)
        at org.mozilla.javascript.gen.c9.call(file:/opt/alfresco-4.0.b/tomcat/webapps/alfresco/WEB-INF/classes/alfresco/templates/webscripts/org/alfresco/repository/forms/form.post.json.js)
        at org.mozilla.javascript.gen.c9.exec(file:/opt/alfresco-4.0.b/tomcat/webapps/alfresco/WEB-INF/classes/alfresco/templates/webscripts/org/alfresco/repository/forms/form.post.json.js)
        at org.alfresco.repo.jscript.RhinoScriptProcessor.executeScriptImpl(RhinoScriptProcessor.java:483)
        at org.alfresco.repo.jscript.RhinoScrip
…
Caused by: org.activiti.engine.ActivitiException: Exception while invoking TaskListener: 11200026 Failed to execute supplied script: 11200025 ReferenceError: "headers" is not defined. (AlfrescoJS#4)
        at org.activiti.engine.impl.bpmn.helper.ClassDelegate.notify(ClassDelegate.java:94)
        at org.activiti.engine.impl.delegate.TaskListenerInvocation.invoke(TaskListenerInvocation.java:34)
        at org.activiti.engine.impl.delegate.DelegateInvocation.proceed(DelegateInvocation.java:37)
        at org.activiti.engine.impl.delegate.DefaultDelegateInterceptor.handleInvocation(DefaultDelegateInterceptor.java:25)
        at org.activiti.engine.impl.persistence.entity.TaskEntity.fireEvent(TaskEntity.java:512)
        … 146 more
Caused by: org.alfresco.scripts.ScriptException: 11200026 Failed to execute supplied script: 11200025 ReferenceError: "headers" is not defined. (AlfrescoJS#4)
        at org.alfresco.repo.jscript.RhinoScriptProcessor.executeString(RhinoScriptProcessor.java:271)
        at org.alfresco.repo.processor.ScriptServiceImpl.executeScriptString(ScriptServiceImpl.java:322)
        at org.alfresco.repo.processor.ScriptServiceImpl.executeScriptString(ScriptServiceImpl.java:300)
        at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
        at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)
        at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
        at java.lang.reflect.Method.invoke(Method.java:597)
        at org.springframework.aop.support.AopUtils.invokeJoinpointUsingReflection(AopUtils.java:309)
        at org.springframework.aop.framework.ReflectiveMethodInvocation.invokeJoinpoint(ReflectiveMethodInvocation.java:183)
        at org.springframework.aop.framework.ReflectiveMethodInvocation.proceed(ReflectiveMethodInvocation.java:150)
        at org.alfresco.repo.security.permissions.impl.AlwaysProceedMethodInterceptor.invoke(AlwaysProceedMethodInterceptor.java:34)
        at org.springframework.aop.framework.ReflectiveMethodInvocation.proceed(ReflectiveMethodInvocation.java:172)
        at org.alfresco.repo.security.permissions.impl.ExceptionTranslatorMethodInterceptor.invoke(ExceptionTranslatorMethodInterceptor.java:44)
        at org.springframework.aop.framework.ReflectiveMethodInvocation.proceed(ReflectiveMethodInvocation.java:172)
        at org.alfresco.repo.audit.AuditMethodInterceptor.invoke(AuditMethodInterceptor.java:146)
        at org.springframework.aop.framework.ReflectiveMethodInvocation.proceed(ReflectiveMethodInvocation.java:172)
        at org.springframework.transaction.interceptor.TransactionInterceptor.invoke(TransactionInterceptor.java:110)
        at org.springframework.aop.framework.ReflectiveMethodInvocation.proceed(ReflectiveMethodInvocation.java:172)
        at org.springframework.aop.framework.JdkDynamicAopProxy.invoke(JdkDynamicAopProxy.java:202)
        at $Proxy249.executeScriptString(Unknown Source)
        at org.alfresco.repo.workflow.activiti.script.ActivitiScriptBase.executeScript(ActivitiScriptBase.java:104)
        at org.alfresco.repo.workflow.activiti.script.ActivitiScriptBase.executeScript(ActivitiScriptBase.java:62)
        at org.alfresco.repo.workflow.activiti.tasklistener.ScriptTaskListener.notify(ScriptTaskListener.java:76)
        at org.activiti.engine.impl.delegate.TaskListenerInvocation.invoke(TaskListenerInvocation.java:34)
        at org.activiti.engine.impl.delegate.DelegateInvocation.proceed(DelegateInvocation.java:37)
        at org.activiti.engine.impl.delegate.DefaultDelegateInterceptor.handleInvocation(DefaultDelegateInterceptor.java:25)
        at org.activiti.engine.impl.bpmn.helper.ClassDelegate.notify(ClassDelegate.java:90)
        … 150 more
Caused by: org.alfresco.error.AlfrescoRuntimeException: 11200025 ReferenceError: "headers" is not defined. (AlfrescoJS#4)
        at org.alfresco.repo.jscript.RhinoScriptProcessor.executeScriptImpl(RhinoScriptProcessor.java:499)
        at org.alfresco.repo.jscript.RhinoScriptProcessor.executeString(RhinoScriptProcessor.java:267)
        … 176 more
Caused by: org.mozilla.javascript.EcmaError: ReferenceError: "headers" is not defined. (AlfrescoJS#4)
        at org.mozilla.javascript.ScriptRuntime.constructError(ScriptRuntime.java:3350)
        at org.mozilla.javascript.ScriptRuntime.constructError(ScriptRuntime.java:3340)
        at org.mozilla.javascript.ScriptRuntime.notFoundError(ScriptRuntime.java:3413)
        at org.mozilla.javascript.ScriptRuntime.name(ScriptRuntime.java:1612)
        at org.mozilla.javascript.gen.c10._c0(AlfrescoJS:4)
        at org.mozilla.javascript.gen.c10.call(AlfrescoJS)
        at org.mozilla.javascript.gen.c10.exec(AlfrescoJS)
        at org.alfresco.repo.jscript.RhinoScriptProcessor.executeScriptImpl(RhinoScriptProcessor.java:483)
        … 177 more
2011-12-20 08:48:34,442  DEBUG [repo.jscript.ScriptLogger] [http-8080-1] org.alfresco.service.cmr.workflow.WorkflowException: 11200027 Impossible de dÃ©marrer le workflow activiti$ReviewByBoss3:75:47203.
 2011-12-20 08:48:34,442  DEBUG [repo.jscript.ScriptLogger] [http-8080-1] Returning 500 status code
‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍

Re: Using wf-email.htmll template from JS

lukasz_turakiew — Tue, 20 Dec 2011 17:04:15 GMT

Hi,

Please try if the following code will work(I have currently no possibility to check it).


person.properties["{http://www.alfresco.org/model/system/1.0}locale"]
‍‍‍

Regards,
Lukasz Turakiewicz

Re: Using wf-email.htmll template from JS

dranakan — Wed, 21 Dec 2011 07:10:47 GMT

It's always returning "en_US". I change Firefox in fr or de, the language change in the forms, but the code always returning "en_US".
I am looking for a code based on the user interface… I am searching…

Re: Using wf-email.htmll template from JS

amandaluniz_z — Thu, 22 Dec 2011 15:07:52 GMT

You will need to pass the locale to the workflow as a parameter…

It runs in another thread, so you will need to add it to the workflow and read it when trying to send the email to set the current thread's locale I18NUtil.setLocale(locale) from java (I think you cannot do it from javascript. Or… add it to the end of the template name (not best option if the template doesn't exist…)

Re: Using wf-email.htmll template from JS

dranakan — Thu, 22 Dec 2011 15:37:20 GMT

Thank you amandaluniz_z.

You will need to pass the locale to the workflow as a parameter…

They could be differents users having different languages during the Workflows.
I don't know if the language of the browser set the i18NUtil… I have to test it.

var acceptLanguage = headers["accept-language"];‍

Why this is not working during the workflow ?

Re: Using wf-email.htmll template from JS

lukasz_turakiew — Thu, 22 Dec 2011 23:36:21 GMT

Hi,

You will need to pass the locale to the workflow as a parameter…

Wouldn't be easier(and faster to implement) to read locale from the user(for example: bpm_assignee.properties["sys:locale"]) to which
email has to be sent rather than passing it as a workflow parameter?

Regards,
Lukasz Turakiewicz

Re: Using wf-email.htmll template from JS

amandaluniz_z — Fri, 23 Dec 2011 07:06:59 GMT

The locale property of the user doesn't mean it matches with the browser. You can change the language of your browser.

The "Accept Language" header sets the Locale for the current user, at least it's that way how it works for webscripts

Re: Using wf-email.htmll template from JS

lukasz_turakiew — Fri, 23 Dec 2011 12:39:32 GMT

The locale property of the user doesn't mean it matches with the browser. You can change the language of your browser.

Of course this property doesn't have to match to the locale within the user`s browser.
However if we suppose that te locale must be passed at the creation stage of the workflow the user can also change the language in the browser to diffrent from which was set.
Why it would be needed(passing the locale at the creation stage of the workflow)? Let`s suppose the following scenario:

1. The workflow is created and 5 users are added to that workflow. For each user a task is created and at the create event of the task the email
to the assigne user must be sent. Passing locale as a workflow parameter doesn`t ensure that the locale passed to the workflow match to the locale in the user browser.
The code that sends emails doesn`t have to be executed in behalf of the user to which the email must be sent.

Re: Using wf-email.htmll template from JS

amandaluniz_z — Fri, 23 Dec 2011 12:57:42 GMT

Sure. You are right

Re: Using wf-email.htmll template from JS

anik — Fri, 11 May 2012 11:47:22 GMT

hi
Please Go to the reply
by lukasz_turakiewicz » 17 Dec 2011, 22:38

Hi,
I tried the code mentioned by lukasz_turakiewicz

Sample code

I tried accessing process variable from JS in FTL(email template) without any controller file.

               var templateArgs = new Array();
               templateArgs['workflowTitle'] = "workflowTitle";
               templateArgs['workflowPooled'] = true;
               templateArgs['workflowDescription'] = "workflowDesc";
               templateArgs['workflowId'] = "workflowId";

               var templateModel = new Array();
               templateModel['args'] = templateArgs;
               mail.parameters.template_model = templateModel;

               mail.execute(search.findNode("workspace://SpacesStore/6b936fof-0758-431b-b5b4-dacb7a8d2128"))

My Question is :
Which File Node reference you are mentioning in Search Api???
Please help

Thanks in advance
Anik

Re: Using wf-email.htmll template from JS

lukasz_turakiew — Fri, 11 May 2012 19:16:34 GMT

Hi Anik,

The node reference passed to the mail.execute method it is a node reference on which you want to execute the action. How it will be used depends on the action code. The code of the mail action is contained in org.alfresco.repo.action.executer.MailActionExecuter class - if you take a look at it you will notice "the mail action might not relate to a specific nodeRef". In my example I passed some valid nodeRef from the Alfresco repository - it may be null or if you pass the nodeRef it must exists.

Regards,
Lukasz Turakiewicz

Re: Using wf-email.htmll template from JS

anik — Sat, 12 May 2012 10:31:26 GMT

Hi lukasz,

Thanks for your quick response
But the things is I am still not very clear of node reference.

Is it the node reference of "Node in Process definition" or of some other file.
If that is the case how can i know the node reference.

Please help

Thanks
Anik

Re: Using wf-email.htmll template from JS

anik — Wed, 16 May 2012 13:26:09 GMT

Hi lukasz,

Thanks for your previous help.
My Code
var templateArgs = new Array();
templateArgs['workflowTitle'] = "workflowTitle";
templateArgs['workflowPooled'] = true;
templateArgs['workflowDescription'] = "workflowDesc";
templateArgs['workflowId'] = "workflowId";

var templateModel = new Array();
templateModel['args'] = templateArgs;
mail.parameters.template_model = templateModel;

mail.execute(bpm_package);
instead of node reference in mail.execute method.

Problem lies when FTL(Template file )access these variable

I am getting an exception saying
Template Exception "args" is not defined
Please help

Thanks
Anik

Re: Using wf-email.htmll template from JS

amandaluniz_z — Thu, 17 May 2012 14:21:05 GMT

Which alfresco version are you working on?

Re: Using wf-email.htmll template from JS

anik — Fri, 18 May 2012 05:07:09 GMT

I am working on Enterprise 3.4.7

The thing is that email script send email if i dont access process variable.
But as soon as i try to use "args" with same script, i get a Template Exception saying
'args' not defined.

My Ftl Template is in repository(CompanyHome>DataDictionery>EmailTemplate>..<here>)
Note: I am not using any Controller File.

Is there any way to to send variable from process definition (JS) into EMail Template (FTL)?

Please Help

Thanks
Anik

Re: Using wf-email.htmll template from JS

amandaluniz_z — Fri, 18 May 2012 09:32:48 GMT

The template_model functionality is available for version 4…. so args nor any other thing you put in mail.parameters.template_model won't be available…

You can check the code in the SDK for MailActionExecuter class. Compare it with the one for version 4 and you'll see that version 4 has the template_model parameter.

Regards,
Adei