topic Re: 'Add new comment' form retrieval in Alfresco Archive

'Add new comment' form retrieval

nicolabeghin — Wed, 16 May 2012 10:01:12 GMT

Hi everyoneI'm integrating Alfresco in a WebDynPro java in a SAP system. I want to manage docs comments in alfresco (for many reasons not in the SAP system). I've already developed a webscript to get HTML-formatted comments, starting from the existing org/alfresco/repository/comments/comments.get (J

Re: 'Add new comment' form retrieval

arnoldschrijve1 — Sat, 19 May 2012 08:55:08 GMT

I am not sure of your exact requirement. From what I understand you are building a UI in WebDynPro on top of the Alfresco repository, but want to use html to render the comments control and communicate to the repository.

You could take a peek at how the comments control is rendered in Alfresco Share. The rendering occurs almost completely client-side in <share-webapp-dir>/components/comments/comments-list.js where rest-style calls are made to the repository to retrieve comment data.
I don't know anything about WebDynPro and whether you can/want to use YUI for rendering, but it may be of help to you.

Re: 'Add new comment' form retrieval

nicolabeghin — Sun, 20 May 2012 12:45:01 GMT

Thanks Arnold, yes I looked up the code and found the Alresco.CommentsList AJAX function so I'm trying to create a webscript/portlet for the rendering of the comments but I'm experiencing issues with the include of files (I've been told it's because I'm referencing some script in the Share tier in the Alfresco tier).. any clues about this?
I wrote some more in https://forums.alfresco.com/en/viewtopic.php?f=36&t=12872
I don't know what to do more

<#include "comments-list.get.head.ftl">
<!– Comments List –>
<link rel="stylesheet" type="text/css" href="http://172.18.101.35:8080/share/res/components/comments/comments-list.css" />
<script type="text/javascript" src="http://172.18.101.35:8080/share/res/components/comments/comments-list.js"></script>
<#if nodeRef??>
   <#assign el=args.htmlid?js_string>
   <script type="text/javascript">//<![CDATA[
      new Alfresco.CommentsList("${el}").setOptions(
      {
         nodeRef: "${nodeRef?js_string}",
         siteId: <#if site??>"${site?js_string}"<#else>null</#if>,
         maxItems: ${maxItems?js_string},
         activity: <#if activityParameterJSON??>${activityParameterJSON}<#else>null</#if>,
         editorConfig:
         {
            inline_styles: false,
            convert_fonts_to_spans: false,
            theme: "advanced",
            theme_advanced_buttons1: "bold,italic,underline,|,bullist,numlist,|,forecolor,|,undo,redo,removeformat",
            theme_advanced_toolbar_location: "top",
            theme_advanced_toolbar_align: "left",
            theme_advanced_resizing: true,
            theme_advanced_buttons2: null,
            theme_advanced_buttons3: null,
            theme_advanced_path: false,
            language: "${locale?substring(0, 2)?js_string}"
         }
      }).setMessages(
         ${messages}
      );
   //]]></script>
   <div id="${el}-body" class="comments-list">

      <h2 class="thin dark">${msg("header.comments")}</h2>

      <div id="${el}-add-comment">
         <div id="${el}-add-form-container" class="theme-bg-color-4 hidden"></div>
      </div>

      <div class="comments-list-actions">
         <div class="left">
            <div id="${el}-actions" class="hidden">
               <button class="alfresco-button" name=".onAddCommentClick">${msg("button.addComment")}</button>
            </div>
         </div>
         <div class="right">
            <div id="${el}-paginator-top"></div>
         </div>
         <div class="clear"></div>
      </div>

      <hr class="hidden"/>

      <div id="${el}-comments-list"></div>

      <hr class="hidden"/>

      <div class="comments-list-actions">
         <div class="left">
         </div>
         <div class="right">
            <div id="${el}-paginator-bottom"></div>
         </div>
         <div class="clear"></div>
      </div>

   </div>
</#if>‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍

Re: 'Add new comment' form retrieval

arnoldschrijve1 — Sun, 20 May 2012 15:21:31 GMT

Yes, the comments-list webscript lives in the Share web-tier and your WebDynPro app probably connects directly to the repository tier (you could also make a call through the web-tier, but I wouldn't consider that best-practice). This means you have to create the webscript here and also place script references and imported files at the proper locations.

Assuming you are using the extension directory you can create the webscript at WEB-INF/class/alfresco/extension/templates/webscripts/com/yourcompany/comments-list
Create the files:
- comments-list.get.desc.xml
- comments-list.get.html.ftl
- comments-list.get.js

The FTL file is mostly the same as the one that exists in Share, but with added script references (the *.get.head.ftl convention doesn't work in repo-tier) something like this:
<script type="text/javascript" src="/alfresco/com/mycompany/comments-list/comments-list.js"></script> (placed directly in alfresco webapp dir, or in /src/web dir in a SDK project).

comments-list.get.js is a bit trickier. It imports alfresco-util.js. I would create a new file in your webscript dir and implement just those functions that are called from comments-list.get.js. You'll have to review the functions that are called and adapt them where they contain share-specific code or make remote calls to the repository (with remote.connect). Since you are in the repository tier now, you have direct access to the code called in these webscripts and you could aggregate it in comments-list.get.js

Something similar needs to be done in the client-side comments-list.js. It needs a bunch of YUI script references in your code to work correctly (all placed below src/web or webapp dir as before). Remember also that it derives from Alfresco.component.Base, so you need to include alfresco.js as well. Then finally there are some calls to Alfresco.constants.URL_SERVICECONTEXT on the Share web-tier that need to be pointed to your new webscript in the repo tier.

So, there is some work involved, but then you should be able to get it up and running. Good luck!

Re: 'Add new comment' form retrieval

nicolabeghin — Sun, 20 May 2012 15:31:33 GMT

Thanks Arnold, that's what I made in the last days (included all the files you suggested) and copied the .js controller and imported Alfresco.Util and created the .tpl files but it seems like a web of inextricable inter-related dependencies and I can't figure out if there's some easier (and cleaner..) solution for this. I'll try with you suggestion keeping only the required part of Alfresco.util.

Of course I made the whole thing on the alfresco server, I'm merely loading the webscript from an iframe in my webdynpro java.

Thanks again A LOT for your help!

Re: 'Add new comment' form retrieval

nicolabeghin — Wed, 23 May 2012 14:02:26 GMT

I've trimmed down alfresco-util.js (removing unused methods and the initial include to surf-doclist.lib.js).
Just 2 things I can't figure out

how to replace
```
remote.connect("alfresco").get('/api/metadata?nodeRef=' + nodeRef);‍
```
(seems like a webservice call to REST API, but is there a way to map each REST API to a local method?)

where is defined the local variable page (page.url etc) ?

Here's the trimmed-down version of alfresco-util.js (that I will embed in comments-list.get.js


var this_AlfrescoUtil = this;

var AlfrescoUtil =
{

   error: function error(code, message, redirect)
   {
      status.code = arguments.length > 0 ? 500 : code;
      status.message = message || 'An error occured';
      status.redirect = arguments.length > 2 ? redirect : true;
      throw new Error(message);
   },

   /**
    * Looks for a parameter in a "safe" way that works in all "environments".
    * Meaning it will look in "page" and "template" if they do exist and not fail /crash if they don't.
    *
    * Looks for an argument in the following order/locations:
    * 1. args[name]
    * 2. page.url.args[name]        
    * 3. page.url.templateArgs[name]
    * 4. template.properties[name]
    * 5. a) if defaultValue has been passed in that is used
    *    b) otherwise the parameter is treated as required and an error is thrown
    *
    * @param name
    * @param defaultValue
    * @return the value for the parameter
    */
   param: function param(name, defaultValue)
   {
      var value;
      if (args[name] && args[name].length != 0)
      {
         value = args[name];
      }
      else if (this_AlfrescoUtil.hasOwnProperty("page") && page.url.args[name] && page.url.args[name].length != 0)
      {
         value = page.url.args[name];
      }
      else if (this_AlfrescoUtil.hasOwnProperty("page") && page.url.templateArgs[name] && page.url.templateArgs[name].length != 0)
      {
         value = page.url.templateArgs[name];
      }
      else if (this_AlfrescoUtil.hasOwnProperty("template") && template.properties[name] && template.properties[name].length != 0)
      {
         value = template.properties[name];
      }
      else if (arguments.length > 1)
      {
         value = defaultValue;
      }
      else
      {
         AlfrescoUtil.error(400, 'Parameter "' + name+ '" is missing.', true);
      }
      model[name] = value;
      return value;
   },

   getMetaData: function getMetaData(nodeRef, defaultValue)
   {
      var result = remote.connect("alfresco").get('/api/metadata?nodeRef=' + nodeRef);
      if (result.status != 200)
      {
         if (defaultValue !== undefined)
         {
            return defaultValue;
         }
         AlfrescoUtil.error(result.status, 'Could not load meta data ' + nodeRef);
      }
      result = eval('(' + result + ')');
      return result;
   },
};
‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍

Re: 'Add new comment' form retrieval

arnoldschrijve1 — Wed, 23 May 2012 15:25:44 GMT

On the first point:

The remote.connect makes a call to the webscript webapps/alfresco/WEB-INF/classes/alfresco/templates/webscripts/org/alfresco/repository/metadata/metadata.get.js. There is not much code there, and the freemarker template just returns the result from the js. So you could include the code in your own script and omit the cross-webscript call.

I am not sure and haven't tested it, but it seems that remote.connect should still work for cross-webscript calls in the alfresco repo tier.

Re: 'Add new comment' form retrieval

arnoldschrijve1 — Wed, 23 May 2012 15:37:56 GMT

On the second issue:

You can try removing page variable altogether as it is not available in repo tier and instead use url.args (url as in http://myurl?myarg={myarg}) and url.templateArgs (http://myurl/{myarg}/mymorestuff)

Re: 'Add new comment' form retrieval

nicolabeghin — Wed, 23 May 2012 16:10:00 GMT

THANKS a lot, I'll apply your suggestions.
Thanks again
nicola

Re: 'Add new comment' form retrieval

nicolabeghin — Thu, 24 May 2012 14:30:18 GMT

It's a nightmare, hope you can give me some hint..

I keep getting a

04240078 Wrapped Exception (with status template): 04243325 Failed to execute script '/com/companyx/comments/comments-list.get.js (in repository store workspace://SpacesStore/Homepage dell'azienda/Dizionario dei dati/Web Script)': 04243324 Invalid node ref - does not contain forward slash: alfresco-util.js

calling the URL
http://127.0.0.1:8080/alfresco/service/com/companyx/components/comments/list?nodeRef=workspace://SpacesStore/4b7198b9-5356-446d-a1a2-747b2896a9ff&site=SpacesStore

by merely including my custom alfresco-util.js (which, btw, does not invoke any method by itself..)
I can't understand why he's trying to automatically create a NodeRef while I'm not invoking any method in AlfrescoUtil (and the URL qualification should be ok as I see with Chrome Inspector it's the same format used for retrieving the comments from the webservice
http://127.0.0.1:8080/share/service/components/node/workspace/SpacesStore/4b7198b9-5356-446d-a1a2-747b2896a9ff/comments?reverse=true&startIndex=0&pageSize=10

alfresco-util.js


<import resource="surf-doclist.lib.js">

var this_AlfrescoUtil = this;

var AlfrescoUtil =
{

   error: function error(code, message, redirect)
   {
      status.code = arguments.length > 0 ? 500 : code;
      status.message = message || 'An error occured';
      status.redirect = arguments.length > 2 ? redirect : true;
      throw new Error(message);
   },

   /**
    * Looks for a parameter in a "safe" way that works in all "environments".
    * Meaning it will look in "page" and "template" if they do exist and not fail /crash if they don't.
    *
    * Looks for an argument in the following order/locations:
    * 1. args[name]
    * 2. page.url.args[name]        
    * 3. page.url.templateArgs[name]
    * 4. template.properties[name]
    * 5. a) if defaultValue has been passed in that is used
    *    b) otherwise the parameter is treated as required and an error is thrown
    *
    * @param name
    * @param defaultValue
    * @return the value for the parameter
    */
   param: function param(name, defaultValue)
   {
      var value;
      if (name in url.templateArgs) value=url.templateArgs[name];
      // if (args[name] && args[name].length != 0)
      // {
      //    value = args[name];
      // }
      // else if (this_AlfrescoUtil.hasOwnProperty("page") && page.url.args[name] && page.url.args[name].length != 0)
      // {
      //    value = page.url.args[name];
      // }
      // else if (this_AlfrescoUtil.hasOwnProperty("page") && page.url.templateArgs[name] && page.url.templateArgs[name].length != 0)
      // {
      //    value = page.url.templateArgs[name];
      // }
      // else if (this_AlfrescoUtil.hasOwnProperty("template") && template.properties[name] && template.properties[name].length != 0)
      // {
      //    value = template.properties[name];
      // }
      else if (arguments.length > 1)
      {
         value = defaultValue;
      }
      else
      {
         AlfrescoUtil.error(400, 'Parameter "' + name+ '" is missing.', true);
      }
      model[name] = value;
      return value;
   },
   
   getRootNode: function getRootNode()
   {
      var rootNode = "alfresco://company/home",
         repoConfig = config.scoped["RepositoryLibrary"]["root-node"];

      if (repoConfig !== null)
      {
         rootNode = repoConfig.value;
      }
      return rootNode;
   },
    
   getNodeDetails: function getNodeDetails(nodeRef, site, options)
   {
     AlfrescoUtil.error(500, 'Noderef is '+nodeRef+' while site is '+site, true);
    return null;
      if (nodeRef)
      {
         var url = '/slingshot/doclib2/node/' + nodeRef.replace('://', '/');
         if (!site)
         {
            // Repository mode
            url += "?libraryRoot=" + encodeURIComponent(AlfrescoUtil.getRootNode());
         }
         var result = remote.connect("alfresco").get(url);

         if (result.status == 200)
         {
            var details = eval('(' + result + ')');
            if (details && (details.item || details.items))
            {
               DocList.processResult(details, options);
               return details;
            }
         }
      }
      return null;
   },
   
   getMetaData: function getMetaData(nodeRef, defaultValue)
   {
//   var result=search.findNode(nodeRef);
     var result = remote.connect("alfresco").get('/api/metadata?nodeRef=' + nodeRef);
      if (result.status != 200)
      {
         if (defaultValue !== undefined)
         {
            return defaultValue;
         }
         AlfrescoUtil.error(result.status, 'Could not load meta data ' + nodeRef);
      }
      result = eval('(' + result + ')');
      return result;
   },

};
‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍

comments-list.get.js
(I deliberately commented any method invocation to be sure no AlfrescoUtil method is invoked explicitly, then even tried to comment out the inclusion of surf-doclist.lib.js)


<import resource="alfresco-util.js">

function getActivityParameters(nodeRef, defaultValue)
{
   var cm = "{http://www.alfresco.org/model/content/1.0}",
      metadata = AlfrescoUtil.getMetaData(nodeRef, {});
   if (metadata.properties)
   {
      if (model.activityType == "document")
      {
         return (
         {
            itemTitle: metadata.properties[cm + 'title'] || metadata.properties[cm + 'name'],
            page: 'document-details',
            pageParams:
            {
               nodeRef: metadata.nodeRef
            }
         });
      }
      else if (model.activityType == "folder")
      {
         return (
         {
            itemTitle: metadata.properties[cm + 'title'] || metadata.properties[cm + 'name'],
            page: 'folder-details',
            pageParams:
            {
               nodeRef: metadata.nodeRef
            }
         });
      }
      else if (model.activityType == "link")
      {
         var lm = "{http://www.alfresco.org/model/linksmodel/1.0}";
         return (
         {
            itemTitle: metadata.properties[lm + "title"],
            page: 'links-view',
            pageParams:
            {
               linkId: metadata.properties[cm + "name"]
            }
         });
      }
      else if (model.activityType == "blog")
      {
         return (
         {
            itemTitle: metadata.properties[cm + 'title'] || metadata.properties[cm + 'name'],
            page: 'blog-postview',
            pageParams:
            {
               postId: metadata.properties[cm + "name"]
            }
         });
      }
   }
   return defaultValue;
}

function main()
{
   // AlfrescoUtil.param('nodeRef', null);
   // AlfrescoUtil.param('site', null);
   // AlfrescoUtil.param('maxItems', 10);
   // AlfrescoUtil.param('activityType', null);
//   model.nodeRef = null;
     status.code=403;
     status.message='Unable to get nodeRef';
     status.redirect=true;

//   if (model.nodeRef) {
   // if (!model.nodeRef)
   // {
   //    // Handle urls that doesn't use nodeRef
   //    AlfrescoUtil.param('postId', null);
   //    if (model.postId)
   //    {
   //       // translate blog post "postId" to a nodeRef
   //       AlfrescoUtil.param('container', 'blog');
   //       model.nodeRef = AlfrescoUtil.getBlogPostDetailsByPostId(model.site, model.container, model.postId, {}).nodeRef;
   //    }
   //    else
   //    {
   //       AlfrescoUtil.param('linkId', null);
   //       if (model.linkId)
   //       {
   //          // translate link's "linkId" to a nodeRef
   //          AlfrescoUtil.param('container', 'links');
   //          model.nodeRef = AlfrescoUtil.getLinkDetailsByPostId(model.site, model.container, model.linkId, {}).nodeRef;
   //       }
   //    }
   // }
      
   //    var documentDetails = AlfrescoUtil.getNodeDetails(model.nodeRef, model.site);
   //    if (documentDetails)
   //    {
   //       var activityParameters = getActivityParameters(model.nodeRef, null);
   //       if (activityParameters)
   //       {
   //          model.activityParameterJSON = jsonUtils.toJSONString(activityParameters);
   //       }
   //    }
   // }
   //    else
   //    {
   //       // Signal to the template that the node doesn't exist and that comments therefore shouldn't be displayed.
   //       model.nodeRef = null;
   //   status.code=403;
   //   status.message='Unable to get nodeRef';
   //   status.redirect=true;
   //    }
}

main();
‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍

just for the sake of clarity this is the webscript descriptor


<webscript>
  <shortname>Comments component</shortname>
  <description>Displays comments for a node</description>
  <url>/com/companyx/components/comments/list</url>
  <transaction>required</transaction> 
  <authentication>user</authentication>
</webscript>
‍‍‍‍‍‍‍‍‍

Please not that I'm loading the files in the Repository -> Data dictionary -> Web script -> com -> companyx -> comments

Thanks again for your invaluable help.

Re: 'Add new comment' form retrieval

nicolabeghin — Thu, 24 May 2012 14:43:36 GMT

Even with an EMPTY AlfrescoUtil I get the same error. Seems like something is happening behing the scenes. Is a NodeRef always created??


var this_AlfrescoUtil = this;
var AlfrescoUtil =
{};
‍‍‍‍‍

Re: 'Add new comment' form retrieval

arnoldschrijve1 — Fri, 25 May 2012 09:12:31 GMT

So if I understand you correctly, if you remove the import of alfresco-util.js the webscript can be called successfully (i.e. executes some test code), but as soon as you have the import, even if AlfrescoUtil does not contain code, you get that error?

I think you should try writing your import using classpath notation as in:

<import resource="classpath:alfresco/templates/webscripts/org/alfresco/cmis/lib/read.lib.js">‍

Re: 'Add new comment' form retrieval

nicolabeghin — Fri, 25 May 2012 09:19:42 GMT

That's right, when I import alfresco-util.js (even without any content in it) I get the aforementioned error.. (even if I remove the include of the doclib library).
Do you know if some other script/procedure is automatically called?

Re: 'Add new comment' form retrieval

arnoldschrijve1 — Fri, 25 May 2012 09:28:29 GMT

One thing in your previous posts that I overlooked: You are loading the webscript files as nodes in the datadictionary/webscripts dir, right?
I,ve never done that, but I could imagine that the imports should be reformulated to include the noderef of the file you are trying to import, rather than its filename. Then the error message would also make sense: it's simply expecting a noderef.

Once again, I'm just guessing. Maybe there's some useful info in the wiki on this, but you could also just give it a try.

Re: 'Add new comment' form retrieval

nicolabeghin — Fri, 25 May 2012 16:52:17 GMT

Thanks Arnold
I got quite near the end, here's my code in case it can be useful for anyone else.

URL reference http://127.0.0.1:8080/alfresco/service/com/companyx/components/comments/list?nodeRef=workspace://SpacesStore/4b7198b9-5356-446d-a1a2-747b2896a9ff&site=SpacesStore&htmlid=prova

comments-list.get.js


<import resource="workspace://SpacesStore/434481d2-27d5-4966-98ff-59729b494168">

function getActivityParameters(nodeRef, defaultValue)
{
   var cm = "{http://www.alfresco.org/model/content/1.0}",
      metadata = AlfrescoUtil.getMetaData(nodeRef, {});
   if (metadata.properties)
   {
      if (model.activityType == "document")
      {
         return (
         {
            itemTitle: metadata.properties[cm + 'title'] || metadata.properties[cm + 'name'],
            page: 'document-details',
            pageParams:
            {
               nodeRef: metadata.nodeRef
            }
         });
      }
   }
   return defaultValue;
}

function main()
{
   AlfrescoUtil.param('nodeRef', null);
   AlfrescoUtil.param('site', null);
   AlfrescoUtil.param('maxItems', 10);
//   AlfrescoUtil.param('activityType', null);
   model.maxItems=10;
   model.locale='it';
   if (model.nodeRef && model.site) {
      // var documentDetails = AlfrescoUtil.getNodeDetails(model.nodeRef, model.site);
//      if (documentDetails) {
//         var activityParameters = getActivityParameters(model.nodeRef, null);
       //  if (activityParameters) model.activityParameterJSON = jsonUtils.toJSONString(activityParameters);
//      }
   }
   else {
      status.code=404;
      status.message='Unable to get nodeRef or site parameter';
      status.redirect=true;
   }
}

main();
‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍

alfresco-util.js


<import resource="workspace://SpacesStore/d4564463-8fba-4ca2-a761-d491bd9a4c08">

var this_AlfrescoUtil = this;

var AlfrescoUtil =
{

   error: function error(code, message, redirect)
   {
      status.code = arguments.length > 0 ? 500 : code;
      status.message = message || 'An error occured';
      status.redirect = arguments.length > 2 ? redirect : true;
      throw new Error(message);
   },

   /**
    * Looks for a parameter in a "safe" way that works in all "environments".
    * Meaning it will look in "page" and "template" if they do exist and not fail /crash if they don't.
    *
    * Looks for an argument in the following order/locations:
    * 1. args[name]
    * 2. page.url.args[name]        
    * 3. page.url.templateArgs[name]
    * 4. template.properties[name]
    * 5. a) if defaultValue has been passed in that is used
    *    b) otherwise the parameter is treated as required and an error is thrown
    *
    * @param name
    * @param defaultValue
    * @return the value for the parameter
    */
   param: function param(name, defaultValue)
   {
      if (args[name]!==undefined) model[name]=args[name];
      else if (defaultValue) model[name]=defaultValue;
      else AlfrescoUtil.error(400, 'Parameter "' + name+ '" is missing.', true);
      return model[name];
   },
   
   getRootNode: function getRootNode()
   {
      var rootNode = "alfresco://company/home",
         repoConfig = config.scoped["RepositoryLibrary"]["root-node"];

      if (repoConfig !== null)
      {
         rootNode = repoConfig.value;
      }
      return rootNode;
   },
    
   getNodeDetails: function getNodeDetails(nodeRef, site, options)
   {
      if (nodeRef)
      {
         // var url = '/slingshot/doclib2/node/' + nodeRef.replace('://', '/');
         // if (!site)
         // {
         //    // Repository mode
         //    url += "?libraryRoot=" + encodeURIComponent(AlfrescoUtil.getRootNode());
         // }
         // var result = remote.connect("alfresco").get(url);
      details = search.findNode(nodeRef);

         if (details != null)
         {
            if (details && (details.item || details.items))
            {
               DocList.processResult(details, options);
               return details;
            } else AlfrescoUtil.error(500, 'details not ok'+jsonUtils.toJSONString(details), true);
         } else AlfrescoUtil.error(500, 'details empty', true);
      }
   return null;
   },
   
   getMetaData: function getMetaData(nodeRef, defaultValue)
   {
//   var result=search.findNode(nodeRef);
     var result = remote.connect("alfresco").get('/api/metadata?nodeRef=' + nodeRef);
      if (result.status != 200)
      {
         if (defaultValue !== undefined)
         {
            return defaultValue;
         }
         AlfrescoUtil.error(result.status, 'Could not load meta data ' + nodeRef);
      }
      result = eval('(' + result + ')');
      return result;
   },

};
‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍

HTML i get from this webscript



   <script type="text/javascript">//<![CDATA[
      new Alfresco.CommentsList("prova").setOptions(
      {
         nodeRef: "workspace://SpacesStore/4b7198b9-5356-446d-a1a2-747b2896a9ff",
         siteId: "SpacesStore",
         maxItems: 10,
         activity: null,
         editorConfig:
         {
            inline_styles: false,
            convert_fonts_to_spans: false,
            theme: "advanced",
            theme_advanced_buttons1: "bold,italic,underline,|,bullist,numlist,|,forecolor,|,undo,redo,removeformat",
            theme_advanced_toolbar_location: "top",
            theme_advanced_toolbar_align: "left",
            theme_advanced_resizing: true,
            theme_advanced_buttons2: null,
            theme_advanced_buttons3: null,
            theme_advanced_path: false,
            language: "it"
         }
      }).setMessages(
         {"message.confirm.delete": "Eliminare questo commento?", "message.delete.success": "Commento eliminato", "message.wait": "Attendere…", "message.delete.failure": "Impossibile eliminare il commento", "header.edit": "Modifica commento…", "header.comments": "Commenti", "message.noComments": "Nessun commento", "message.loadeditform.failure": "Impossibile caricare il modulo di modifica del commento", "message.savecomment": "Salvataggio del commento in corso…", "message.confirm.delete.title": "Elimina commento", "header.add": "Aggiungi commento…", "button.addComment": "Aggiungi commento", "link.deleteComment": "Elimina commento", "button.save": "Salva", "label.avatar": "Avatar", "button.cancel": "Annulla", "message.savecomment.failure": "Impossibile salvare il commento", "link.editComment": "Modifica commento"}
      );
   //]]></script>
   <div id="prova-body" class="comments-list">

      <h2 class="thin dark">Commenti</h2>

      <div id="prova-add-comment">
         <div id="prova-add-form-container" class="theme-bg-color-4 hidden"></div>
      </div>

      <div class="comments-list-actions">
         <div class="left">
            <div id="prova-actions" class="hidden">
               <button class="alfresco-button" name=".onAddCommentClick">Aggiungi commento</button>
            </div>
         </div>
         <div class="right">
            <div id="prova-paginator-top"></div>
         </div>
         <div class="clear"></div>
      </div>

      <hr class="hidden"/>

      <div id="prova-comments-list"></div>

      <hr class="hidden"/>

      <div class="comments-list-actions">
         <div class="left">
         </div>
         <div class="right">
            <div id="prova-paginator-bottom"></div>
         </div>
         <div class="clear"></div>
      </div>

   </div>
‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍

I think now it's sufficient to reference alfresco.js (and CSS) with normal javascript <link> and that's it, am I right?

Re: 'Add new comment' form retrieval

arnoldschrijve1 — Sat, 26 May 2012 07:56:03 GMT

That is really cool, Nicola! I googled a bit on it, but couldn't find good reference on specifying imports in data dictionary webscript. I was about to advice you to include all code in the webscript js as an alternative, but it is great that this now works.

It looks indeed that including comments-list.js and alfresco.js script references will get it working.

Re: 'Add new comment' form retrieval

nicolabeghin — Mon, 28 May 2012 09:24:19 GMT

Thanks again for the support Alfred.
I'm stuck again cause the template can't find some user-defined functions like <@markup>, <@link>, <@script>… Do you have any suggestion? It seems like an endless job. any way to turn off freemarker error at least while trying to get something up and running?

The error is quite self-explanatory and I get it's because no predefined (and required) variables are set before the output of the freemarker template, but shouldn't these function be available to any alfresco template? not event context is defined..

'Expression theme is undefined on line 14, column 9

comments-list.get.html.ftl


<#–
   RESOURCES
–>

   <!– Icons –>
   <link rel="shortcut icon" href="/share/res/favicon.ico" type="image/vnd.microsoft.icon" />
   <link rel="icon" href="/share/res/favicon.ico" type="image/vnd.microsoft.icon" />


   <!– YUI –>
   <link rel="stylesheet" type="text/css" href="/share/res/css/yui-fonts-grids.css" />
   <link rel="stylesheet" type="text/css" href="/share/res/yui/columnbrowser/assets/columnbrowser.css" />
   <link rel="stylesheet" type="text/css" href="/share/res/yui/columnbrowser/assets/skins/default/columnbrowser-skin.css" />
   <#if theme = 'default'>
   <link rel="stylesheet" type="text/css" href="/share/res/yui/assets/skins/default/skin.css" />
   <#else>
   <link rel="stylesheet" type="text/css" href="/share/res/themes/${theme}/yui/assets/skin.css" />
   </#if>
   <#if DEBUG>
   <script type="text/javascript" src="/share/res/js/log4javascript.v1.4.1.js"></script>
   <script type="text/javascript" src="/share/res/yui/yahoo/yahoo-debug.js"></script>
   <script type="text/javascript" src="/share/res/yui/event/event-debug.js"></script>
   <script type="text/javascript" src="/share/res/yui/dom/dom-debug.js"></script>
   <script type="text/javascript" src="/share/res/yui/dragdrop/dragdrop-debug.js"></script>
   <script type="text/javascript" src="/share/res/yui/animation/animation-debug.js"></script>
   <script type="text/javascript" src="/share/res/yui/logger/logger-debug.js"></script>
   <script type="text/javascript" src="/share/res/yui/connection/connection-debug.js"></script>
   <script type="text/javascript" src="/share/res/yui/element/element-debug.js"></script>
   <script type="text/javascript" src="/share/res/yui/get/get-debug.js"></script>
   <script type="text/javascript" src="/share/res/yui/yuiloader/yuiloader-debug.js"></script>
   <script type="text/javascript" src="/share/res/yui/button/button-debug.js"></script>
   <script type="text/javascript" src="/share/res/yui/container/container-debug.js"></script>
   <script type="text/javascript" src="/share/res/yui/menu/menu-debug.js"></script>
   <script type="text/javascript" src="/share/res/yui/json/json-debug.js"></script>
   <script type="text/javascript" src="/share/res/yui/selector/selector-debug.js"></script>
   <script type="text/javascript" src="/share/res/yui/datasource/datasource-debug.js"></script>
   <script type="text/javascript" src="/share/res/yui/autocomplete/autocomplete-debug.js"></script>
   <script type="text/javascript" src="/share/res/yui/paginator/paginator-debug.js"></script>
   <script type="text/javascript" src="/share/res/yui/datatable/datatable-debug.js"></script>
   <script type="text/javascript" src="/share/res/yui/history/history-debug.js"></script>
   <script type="text/javascript" src="/share/res/yui/treeview/treeview-debug.js"></script>
   <script type="text/javascript" src="/share/res/yui/autocomplete/autocomplete-debug.js"></script>
   <script type="text/javascript" src="/share/res/yui/yui-patch.js"></script>
   <script type="text/javascript">//<![CDATA[
      YAHOO.util.Event.throwErrors = true;
   //]]></script>
   <#else>
   <script type="text/javascript" src="/share/res/js/yui-common.js"></script>
   </#if>
   <script type="text/javascript" src="/share/res/js/bubbling.v2.1.js"></script>
   <script type="text/javascript">//<![CDATA[
      YAHOO.Bubbling.unsubscribe = function(layer, handler, scope)
      {
         this.bubble[layer].unsubscribe(handler, scope);
      };
   //]]></script>


   <!– Common i18n msg properties –>
   <script type="text/javascript" src="/share/service/messages.js?locale=${locale}"></script>

   <!– Alfresco web framework constants –>
   <script type="text/javascript">//<![CDATA[
      Alfresco.constants = Alfresco.constants || {};
      Alfresco.constants.DEBUG = ${DEBUG?string};
      Alfresco.constants.AUTOLOGGING = ${AUTOLOGGING?string};
      Alfresco.constants.PROXY_URI = window.location.protocol + "//" + window.location.host + "/share/proxy/alfresco/";
      Alfresco.constants.PROXY_URI_RELATIVE = "/share/proxy/alfresco/";
      Alfresco.constants.PROXY_FEED_URI = window.location.protocol + "//" + window.location.host + "/share/proxy/alfresco-feed/";
      Alfresco.constants.THEME = "${theme}";
      Alfresco.constants.URL_CONTEXT = "/share/";
      Alfresco.constants.URL_RESCONTEXT = "/share/res/";
      Alfresco.constants.URL_PAGECONTEXT = "/share/page/";
      Alfresco.constants.URL_SERVICECONTEXT = "/share/service/";
      Alfresco.constants.URL_FEEDSERVICECONTEXT = "/share/feedservice/";
      Alfresco.constants.USERNAME = "${(user.name!"")?js_string}";
      Alfresco.constants.SITE = "<#if page??>${(page.url.templateArgs.site!"")?js_string}</#if>";
      Alfresco.constants.PAGEID = "<#if page??>${(page.url.templateArgs.pageid!"")?js_string}</#if>";
      Alfresco.constants.PORTLET = ${PORTLET?string};
      Alfresco.constants.PORTLET_URL = unescape("${(context.attributes.portletUrl!"")?js_string}");
      Alfresco.constants.JS_LOCALE = "${locale}";
   <#if PORTLET>
      document.cookie = "JSESSIONID=; expires=Thu, 01 Jan 1970 00:00:00 GMT; path=/share";
   </#if>
   //]]></script>


   <!– Alfresco web framework common resources –>
<#if PORTLET>
   <link rel="stylesheet" type="text/css" href="/share/res/css/portlet.css" />
</#if>
   <link rel="stylesheet" type="text/css" href="/share/res/css/base.css" />
   <link rel="stylesheet" type="text/css" href="/share/res/css/yui-layout.css" />
   <script type="text/javascript" src="/share/res/js/flash/AC_OETags.js"></script>
   <script type="text/javascript" src="/share/res/js/alfresco.js"></script>
   <script type="text/javascript" src="/share/res/modules/editors/tiny_mce/tiny_mce${DEBUG?string("_src", "")}.js"></script>
   <script type="text/javascript" src="/share/res/modules/editors/tiny_mce.js"></script>
   <script type="text/javascript" src="/share/res/modules/editors/yui_editor.js"></script>
   <script type="text/javascript" src="/share/res/js/forms-runtime.js"></script>


   <!– Share Constants –>
   <script type="text/javascript">//<![CDATA[
      Alfresco.service.Preferences.FAVOURITE_DOCUMENTS = "org.alfresco.share.documents.favourites";
      Alfresco.service.Preferences.FAVOURITE_FOLDERS = "org.alfresco.share.folders.favourites";
      Alfresco.service.Preferences.FAVOURITE_SITES = "org.alfresco.share.sites.favourites";
      Alfresco.service.Preferences.IMAP_FAVOURITE_SITES = "org.alfresco.share.sites.imapFavourites";
      Alfresco.service.Preferences.COLLAPSED_TWISTERS = "org.alfresco.share.twisters.collapsed";
      Alfresco.service.Preferences.RULE_PROPERTY_SETTINGS = "org.alfresco.share.rule.properties";
      Alfresco.constants.URI_TEMPLATES =
      {
         <#list config.scoped["UriTemplate"]["uri-templates"].childrenMap["uri-template"] as c>
         "${c.attributes["id"]}": "${c.value}"<#if c_has_next>,</#if>
         </#list>
      };
      Alfresco.constants.HELP_PAGES =
      {
         <#list config.scoped["HelpPages"]["help-pages"].children as c>
         "${c.name}": "${c.value}"<#if c_has_next>,</#if>
         </#list>
      };
      Alfresco.constants.HTML_EDITOR = 'tinyMCE';
   //]]></script>


   <!– Share resources –>
   <script type="text/javascript" src="/share/res/js/share.js"></script>
   <script type="text/javascript" src="/share/res/js/lightbox.js"></script>
   <link rel="stylesheet" type="text/css" href="/share/res/themes/${theme}/presentation.css" />


   <#if (templateStylesheets?size > 0)>
   <!– Common stylesheets gathered to workaround IEBug KB262161 –>
   <style type="text/css" media="screen">
      <#list templateStylesheets as href>
      @import "${href}";
      </#list>
   </style>
   </#if>

   <#– Use this "markup id" to add in a extension's resources –>


<!– Comments List –>
<link rel="stylesheet" type="text/css" href="/share/res/components/comments/comments-list.css" />
<script type="text/javascript" src="/share/res/components/comments/comments-list.js"></script>

<#if nodeRef??>
   <#assign el=args.htmlid?js_string>
   <script type="text/javascript">//<![CDATA[
      new Alfresco.CommentsList("${el}").setOptions(
      {
         nodeRef: "${nodeRef?js_string}",
         siteId: <#if site??>"${site?js_string}"<#else>null</#if>,
         maxItems: ${maxItems?js_string},
         activity: <#if activityParameterJSON??>${activityParameterJSON}<#else>null</#if>,
         editorConfig:
         {
            inline_styles: false,
            convert_fonts_to_spans: false,
            theme: "advanced",
            theme_advanced_buttons1: "bold,italic,underline,|,bullist,numlist,|,forecolor,|,undo,redo,removeformat",
            theme_advanced_toolbar_location: "top",
            theme_advanced_toolbar_align: "left",
            theme_advanced_resizing: true,
            theme_advanced_buttons2: null,
            theme_advanced_buttons3: null,
            theme_advanced_path: false,
            language: "${locale?substring(0, 2)?js_string}"
         }
      }).setMessages(
         ${messages}
      );
   //]]></script>
   <div id="${el}-body" class="comments-list">

      <h2 class="thin dark">${msg("header.comments")}</h2>

      <div id="${el}-add-comment">
         <div id="${el}-add-form-container" class="theme-bg-color-4 hidden"></div>
      </div>

      <div class="comments-list-actions">
         <div class="left">
            <div id="${el}-actions" class="hidden">
               <button class="alfresco-button" name=".onAddCommentClick">${msg("button.addComment")}</button>
            </div>
         </div>
         <div class="right">
            <div id="${el}-paginator-top"></div>
         </div>
         <div class="clear"></div>
      </div>

      <hr class="hidden"/>

      <div id="${el}-comments-list"></div>

      <hr class="hidden"/>

      <div class="comments-list-actions">
         <div class="left">
         </div>
         <div class="right">
            <div id="${el}-paginator-bottom"></div>
         </div>
         <div class="clear"></div>
      </div>

   </div>
</#if>
‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍

Re: 'Add new comment' form retrieval

arnoldschrijve1 — Mon, 28 May 2012 09:51:30 GMT

Am I assuming correctly that you were having trouble with the @ directives in the freemarker template, so you've created the provided template that has all code inline, but it still gives errors because of undefined global variables such as 'theme'?

You'll have to look whether you really need these variables, and if so, add them to the model in the webscript js.
Looking further at the template I think it has too much share plumbing still in it. I think you'll should have a careful look at the code and remove anything share-related that is not needed by your comments-list. Then finally make sure all remaining script and stylesheet references point to the alfresco tier, not to share.

(Edit: Nicola, I was somehow editing to a previous version of your current post when I wrote message above)

Re: 'Add new comment' form retrieval

arnoldschrijve1 — Mon, 28 May 2012 10:00:53 GMT

The alfresco repo tier has no full configuration for Spring Surf. In share you can find some @ declarations in share/WEB-INF/classes/alfresco/site-webscripts/org/alfresco/components/component.head.inc

Re: 'Add new comment' form retrieval

nicolabeghin — Mon, 11 Jun 2012 10:54:05 GMT

Hi Arnold,
sorry for this huge lag in replying.. I had to focus on some more recently-due Alfresco tasks and let this issue delay.
At the moment I'm trying to add new comments via SOAP (via the alfresco-webservice.jar of the Alfresco SDK but seems like it's not supported), I'll keep you updated as soon as I'll work in this issue again.

Thanks again for your invaluable support, hope I'll be able to close the issue and get something useful for you too!