topic Re: [Solved][Share] Customise DocumentList in Alfresco Archive

[Solved][Share] Customise DocumentList

lamba — Wed, 23 Jun 2010 10:09:23 GMT

Hello,I created a custom folder type and I added it to Alfresco 3.2r2 with succes.For this custom folder type, I have a specific contents to show by using a WebScript. For Alfresco Explorer, I was able to do it by replacing browse.jsp by custombrowse.jsp in web-client-config-custom.xml as follows:

Re: [Solved][Share] Customise DocumentList

lamba — Thu, 24 Jun 2010 09:18:59 GMT

any idea please :roll:

Re: [Solved][Share] Customise DocumentList

lamba — Mon, 28 Jun 2010 15:01:21 GMT

no body for reply?!
no Alfresco engineer for help?!

Re: [Solved][Share] Customise DocumentList

raptus — Tue, 29 Jun 2010 07:17:56 GMT

I think you must learn more about Surf platform structure…. Share has dashlets, you must modify dashlets but a dashlet is not a webscript as you have seen in Alfresco.

Me too I don't understand at all how it works, and I'd like to know how to hard-modify dashlets (i.e. my-tasks dashlet to work outside the dashboard) and how to put this webscripts into share pages…

I am not so expert but I think this is the only way Share customization…. You have to find dashlet components (FTL & JS) and change everything you need.

Raptus

Re: [Solved][Share] Customise DocumentList

lamba — Tue, 29 Jun 2010 10:29:00 GMT

thank you raptus for this reply.

I crossed the file documentlist.js and I found that the list of the documents of a given space is filled and posted by means of the "widgets.dataSource" and "widgets.dataTable".

What I want, it is to show the doclist according to the following treatment:

If the folder have a customFolder type:
Do not use the "widgets.dataSource" and "widgets.dataTable"
But create an iframe in the doclist zone of the WS documentlist.get.html.ftl
And this iframe will call a WS which I developed.

Otherwise:
Use the "widgets.dataSource" and the "widgets.dataTable"

Further to your advice I am going to try to understand the logic of creation of pages under Share.

Any help will be welcome.

Thank you in advance.

Re: [Solved][Share] Customise DocumentList

raptus — Tue, 29 Jun 2010 11:20:43 GMT

It seems you have more experience than me, if you find an easy way to modify dashlets or a way to manage them like simple webscripts please write your suggestions, I always get problems (like undefined htmlid or many exceptions) if I touch them.
Sorry but as you can see I am a beginner,

Raptus

Re: [Solved][Share] Customise DocumentList

lamba — Tue, 29 Jun 2010 12:10:03 GMT

Maybe

Raptus, try this
http://www.ixxus.com/blog/2009/04/dashlet-tips/

Let me know if you have any more question.

Re: [Solved][Share] Customise DocumentList

lamba — Wed, 30 Jun 2010 09:35:42 GMT

Hello,

I managed to create a method which allows me to show what I want instead of DataTable, but I need the noderef of the current node to make the test (If the folder is of type customFolder). This nodeRef is got back by the WS doclist.get.json.ftl.

My question now, how could I get back the nodeRef of the current or parent node from the file documentlist.js :?:

N.B: in other places of the file documentlist.js the call me.doclistMetadata.parent.nodeRef; with me.doclistMetadata = oFullResponse.metadata; is used to get back this information.

Thank you for your help :?

Re: [Solved][Share] Customise DocumentList

mikeh — Wed, 30 Jun 2010 11:23:42 GMT

The parent nodeRef is also at the top of the response from the doclist data webscript.

Thanks,
Mike

Re: [Solved][Share] Customise DocumentList

lamba — Wed, 30 Jun 2010 12:14:27 GMT

Thanks Mike,

Yes I know, but how could I get back this nodeRef on the documentlist.js file ?
I tried the call me.doclistMetadata.parent.nodeRef; but the doclistMetadata is always null !?

Re: [Solved][Share] Customise DocumentList

mikeh — Wed, 30 Jun 2010 13:04:16 GMT

Without seeing the rest of your customisation, I'm not sure how you're integrating with the existing code. Is it a problem that "me" isn't defined? How are you accessing any other data from the webscript?

Thanks,
Mike

Re: [Solved][Share] Customise DocumentList

lamba — Wed, 30 Jun 2010 13:51:37 GMT

Mike, this is the customisation that I did

I added the nodeType property to the doclist.get.json.ftl file as below:


…
"metadata":
   {
      "parent":
      {
         <#if doclist.parent??>
         "nodeRef": "${doclist.parent.nodeRef}",
         "nodeType": "${doclist.parent.type}",
       </#if>
       
         "permissions":
         {
            "userRole": "${user.role!""}",
            "userAccess":
…
‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍

I created the method below in the documentlist.js file


_setupCustomDataTable: function DL__setupCustomDataTable()
      {
         var me = this;
      var parentNodeRef = ????;
      var src = Alfresco.constants.PROXY_URI + "/custom/browsedoclist?nodeRef=" + parentNodeRef;
      var customIframe = '"<iframe src="' + src + '" frameborder="0" Marginwidth="0" Marginheight="0" width="100%" height="320" ></iframe>"';
         
       this.widgets.custompanel = new YAHOO.widget.Module(this.id + "-customdocuments", {visible:true } );
       this.widgets.custompanel.setBody(customIframe); 
            
       this.widgets.custompanel.render();
     },
‍‍‍‍‍‍‍‍‍‍‍‍‍‍

I call this method on the documentlist.js file as below:


       var nodeType = me.doclistMetadata.parent.nodeType;
       if(nodeType === "{extension.Custom}customFolder"){
         this._setupDataTable(columnDefinitions);
       }else{
         this._setupCustomDataTable();
       }
‍‍‍‍‍‍‍‍

I tested the method with a static parentNodeRef and it worked fine. But I can't get the current parentNodeRef !

What I missed?

Thanks,

Re: [Solved][Share] Customise DocumentList

stevegreenbaum — Wed, 30 Jun 2010 14:43:55 GMT

Not sure I am following the full intent of your customization, but when looking at the documentation for share-config.custom.xml, the OOTB file shows that you can reference a custom Type including a custom folder type in the UI. Have you looked at this approach?

Re: [Solved][Share] Customise DocumentList

mikeh — Wed, 30 Jun 2010 15:23:01 GMT

Why not just do: this._setupCustomDataTable(me.doclistMetadata.parent.nodeRef) then pick it up as a function argument?

Thanks,
Mike

Re: [Solved][Share] Customise DocumentList

lamba — Thu, 01 Jul 2010 09:38:36 GMT

Thank you Steve.
In fact, I tried the approach that you proposed but that did not work.

On the other hand, for your proposition Mike, I have the me.doclistMetadata variable which is null.
I think that it is necessary to take advantage of the WS doclist.get.json.ftl to initialize it but I have two problems at this level:

1. How to get back variables filterData and currentPath on the documentlist.js.
NB: this.currentPath and this.currentFilter.filterData return null !

2. How to parse the file json result of the call of this WS (doclist.get.json.ftl).

thanks,

Re: [Solved][Share] Customise DocumentList

mikeh — Thu, 01 Jul 2010 13:11:31 GMT

Let's take a step back. This code you posted earlier:

       var nodeType = me.doclistMetadata.parent.nodeType;
       if(nodeType === "{extension.Custom}customFolder"){
         this._setupDataTable(columnDefinitions);
       }else{
         this._setupCustomDataTable();
       }‍‍‍‍‍‍

Exactly where has that been added?

I suspect, because of the _setupDataTable() call in there, you're trying to operate on the data before it's even been requested. As you should be able to see from the implementation, all _setupDataTable() does is to initialise the YUI components; it's not until the handleDataReturnPayload() callback is invoked that you can start acting on the data itself. Remember the page is all AJAX-based hence asynchronous.

Thanks,
Mike

Re: [Solved][Share] Customise DocumentList

lamba — Thu, 01 Jul 2010 14:35:39 GMT

Yes, you are right Mike, in my documentlist.js I replaced the _setupDataTable() by my code.
Mike, I am not very familiar with AJAX and especially its use in Share.

Now please, where can I put my code and get it working? :cry:
I tried in and after the call of the handleDataReturnPayload() but that did not work because the calls oResponse.meta.metadata.parent; and oResponse.meta.parent; are not any more recognized, they return null

thanks

Re: [Solved][Share] Customise DocumentList

mikeh — Thu, 01 Jul 2010 14:45:56 GMT

There's an entire set of Ajax helper code in alfresco.js, e.g.

Alfresco.util.Ajax.jsonGet(
{
   url: [webscript URL],
   successCallback:
   {
      fn: this.onDataReturn,
      scope: this
   }
});

function onDataReturn(response)
{
   // Do something with response.json
}
‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍

There are lots of examples of this throughout the Share code. I would recommend walking through some of the existing code. You might also find our recently-released book (Wrox) useful.

Thanks,
Mike

P.S. Did you not get the e-mail I forwarded via Ash?

Re: [Solved][Share] Customise DocumentList

lamba — Thu, 01 Jul 2010 15:25:12 GMT

OK Mike, I will try this.

For the e-mail that you forwarded via Ash, I didn't get it.
In fact, I didn't know "Ash", what is it?

Thank you very much Mike.

Re: [Solved][Share] Customise DocumentList

mikeh — Thu, 01 Jul 2010 15:56:59 GMT

For the e-mail that you forwarded via Ash, I didn't get it.
In fact, I didn't know "Ash", what is it?

Never mind, I guess he replied to Andrew directly.

Thanks,
Mike