topic Re: Customise Share search results in Alfresco Archive

Customise Share search results

benarrayx — Mon, 24 May 2010 17:22:07 GMT

Hi there, I'm trying to modfiy my Share search results in order to display a custom metadata field. I can see there are 2 steps:1. modify tomcat/webapps/alfresco/WEB-INF/classes/alfresco/templates/webscripts/org/alfresco/slingshot/search/search.get.json.ftl in order to send the metadata value via JS

Re: Customise Share search results

benarrayx — Mon, 24 May 2010 17:48:48 GMT

For reference, I've also tried:

- item.status - never shows any data
- item.properties["trc:status"] - throws error "Expression item.properties is undefined"

Cheers, Ben

Re: Customise Share search results

tommorris — Tue, 25 May 2010 07:22:52 GMT

Hi there.

You've found the correct webscript, but you need to modify a bit more. The 'item' javascript object is a regular javascript data-object (aka 'value object' or 'data transfer object') and not the alfresco-node object that you're expecting.

Have a look at the JS file that accompanies the FTL (alfresco/WEB-INF/classes/alfresco/templates/webscripts/org/alfresco/slingshot/search/search.get.js)… you'll see that it includes the following JS file: alfresco/WEB-INF/classes/alfresco/templates/webscripts/org/alfresco/slingshot/search/search.lib.js. Modify this file. In particular, look for the function 'getDocumentItem' and all will become clear.

Tom
http://www.ixxus.com

Re: Customise Share search results

benarrayx — Tue, 25 May 2010 08:54:41 GMT

Hi Tom, many thanks for that.

I added my property to the js object created in getDocumentItem, as follows:

trcStatus: (node.hasAspect("trc:statusA")) ? node.properties["trc:status"] : ""‍

However, this never returns anything, regardless or not if the document has the aspect. I also tried adding a static property:

item.ben = "ben";‍

If I try and output this in search.get.json.ftl:

"ben": "${item.ben}"‍

I get an error telling me "jsonUtils.encodeJSONString(x) is undefined". I figured out this was probably because the property was null/empty, so wrapped it as follows:

"ben": "<#if item.ben??>${item.ben}</#if>"‍

which stops the error, but the output is always empty. It seems as though the changes I'm making to webapps/alfresco/WEB-INF/classes/alfresco/templates/webscripts/org/alfresco/slingshot/search/search.lib.js aren't getting carried through to search.get.json.ftl.

Can you offer me any further advice?

Regards, Ben

Re: Customise Share search results

benarrayx — Wed, 26 May 2010 07:56:54 GMT

Ah, seems like a restart of Alfresco was required to get the new data coming through - I assumed since it was javascript it would be interpreted on the fly, clearly not the case!!

Anyway, all working good now, thanks for the help Tom

Ben

Re: Customise Share search results

kyriakos — Wed, 26 May 2010 08:14:42 GMT

benArrayX so you managed to customise share search to lookup in custom metadata-aspects?

Re: Customise Share search results

benarrayx — Wed, 26 May 2010 10:04:55 GMT

Hi kyriakos, I didn't modify the search to search in custom metadata fields, only to output the values of a custom metadata field in the search results.

1 final step not mentioned here is that you need to edit /webapps/share/components/search/search.js to include your custom field in the definition. In the Search_onReady function:

fields: ["nodeRef", "type", "name", "displayName", "description",
                      "modifiedOn", "modifiedByUser", "modifiedBy", "size",
                      "title", "browseUrl", "trcStatus", "site", "tags"]‍‍‍

(I added the trcStatus field), and then modify the output in the Search_renderCellDescription function:

if (status !== undefined && status !== '')
            desc += '<br />Status: ' + status;
         else
            desc += '<br />Status: Unknown / incorrect document type';‍‍‍‍

Cheers, Ben

Re: Customise Share search results

kyriakos — Wed, 26 May 2010 11:49:17 GMT

So Ben i other words, you have created a custom metadata field, you put let's say the value " dog" in that field then you go to search and write "dog" and you have a result? with these changes?

Re: Customise Share search results

tommorris — Wed, 26 May 2010 17:14:38 GMT

Hi Ben. Sorry for the late reply.
yes, sorry - I forgot to mention the 'fields' thing…

Re: Customise Share search results

benarrayx — Thu, 27 May 2010 10:03:17 GMT

Hi kyriakos, that is not the case. This topic is not about searching custom meta-data fields, it's about displaying the contents of custom meta-data fields in search results. I am not searching custom fields, AFAIK that's not possible but is in the roadmap.

Cheers, Ben

Re: Customise Share search results

kyriakos — Thu, 27 May 2010 11:14:45 GMT

thanx ben for the answer

Re: Customise Share search results

tommorris — Thu, 27 May 2010 15:49:30 GMT

Hi there kyriakos.

You can modify the process that constructs the lucene query that dictates the search if you like.

You can copy the js library included in the alfresco-side webscript that conducts this search: ''search.lib.js" and move it to the extension directory, and then modify it.
(alfresco\WEB-INF\classes\alfresco\extension\templates\webscripts\org\alfresco\slingshot\search\search.lib.js)

Then change this function: "getSearchResults", where you can see what you'll need to change.

Tom
http://www.ixxus.com

Re: Customise Share search results

pablog_ — Fri, 21 Feb 2014 15:37:00 GMT

Hi four years later!!, now, in alfresco 4.2, the function "Search_onReady" don't have "fields:" property, I have made all the changes that your say in the post and the output retrieve the next exception:


search.lib.js: Skipping node due to exception when processing query result: TypeError: properties is not a function, it is org.alfresco.repo.jscript.ContentAwareScriptableQNameMap.
‍‍‍

Thanks!

Re: Customise Share search results

gdey — Wed, 07 May 2014 03:55:14 GMT

Hi
I am trying to add new functionality to the search , I followed this blog and did the following
extension-modules.xml
<blockcode>
<extension>
<modules>
    <module>
      <id>Test Custom Search</id>
      <version>1.0</version>
      <customizations>
        <customization>
          <targetPackageRoot>org.alfresco.components.search</targetPackageRoot>
          <sourcePackageRoot>tutorials</sourcePackageRoot>
        </customization>
      </customizations>
      <auto-deploy>true</auto-deploy>
    </module>

</modules>
</extension>

</blockcode>

search.get.html.ftl

<blockcode>
<@markup id="custom-search-dependencies" target="js" action="after" scope="global">
   <#– JavaScript Dependencies –>
   <!–<@script src="${url.context}/scripts/custom-search.js" group="search"/>–>
   <!–<@script src="http://localhost:9080/share/scripts/custom-search.js" group="search"/>–>
   <@script src="${url.context}/res/scripts/custom-search.js" group="search"/>
</@>
</blockcode>

search.get.js
<blockcode>
// Find the default DocumentList widget and replace it with the custom widget
for (var i=0; i<model.widgets.length; i++)
{
if (model.widgets.id == "Search")
{
    model.widgets.name = "Test.Search";
}
}
</blockcode>
custom-search.js
<javascript>
// Declare namespace…
if (typeof Test == undefined || !Test) { var Test = {}; }
if (!Test.Search) { Test.Search = {}; }
(function()
{
   /**
    * YUI Library aliases
    */
   var Dom = YAHOO.util.Dom,
       Event = YAHOO.util.Event;

   /**
    * Alfresco Slingshot aliases
    */
   var $html = Alfresco.util.encodeHTML;

   /**
    * Search constructor.
    *
    * @param {String} htmlId The HTML id of the parent element
    * @return {Test.Search} The new Search instance
    * @constructor
    */
   Test.Search = function(htmlId)
   {
      Alfresco.util.PopupManager.displayMessage({
           text: "Inside constructor !"
         });
      Test.Search.superclass.constructor.call(this, htmlId);

      // Decoupled event listeners
      YAHOO.Bubbling.on("onSearch", this.onSearch, this);

      return this;
   };

   YAHOO.extend(Test.Search, Alfresco.Search,
   {


      /**
       * Click event for Repository search link
       *
       * @method onRepositorySearch
       */
      onRepositorySearch: function Search_onRepositorySearch(e, args)
      {

         Test.Search.superclass.Search_onRepositorySearch(e,args);
         // Pop-up a message…
          Alfresco.util.PopupManager.displayMessage({
            text: "Change added"
          });

      }
   });
})();

</javascript>

I created a share amp project and placed the custom-search.js under src/main/resource/script/custom-search.js

The search stopped working because it cant find the custom-search.js . On a debug mode java console I can see
GET http://localhost:9080/share/res/share/scripts/custom-search.js 404 (Not Found)

I tried different option with the @script but it keep complaining , not sure how it is finding two share.

Could not get the example to work.
thanks
Gautam

Re: Customise Share search results

anotheralfresco — Thu, 09 Apr 2015 15:12:35 GMT

Gautam,
Were you able to get your example to work? I am trying to do the same thing and I am not able to get it to work either. If you got it to work, can you post your solution.
Thanks