topic Re: How to send webscript response as file (file download box) in Alfresco Archive

How to send webscript response as file (file download box)

g_rathod — Fri, 23 Mar 2012 09:45:25 GMT

Hi,In alfresco 4 share enterprise, When I perform advance search, I place one more button called "Export Search", when search result gives me nodes (searched results).e.g. Let say I got 5 results. Following are the steps I performed.1) Get 5 nodeRefs from client side search.js2) Calling repo side we

Re: How to send webscript response as file (file download box)

erikwinlof — Fri, 23 Mar 2012 10:05:25 GMT

Make sure you get your webscript to set the "Content-Disposition" header to something like "attachment; filename=MyExcelDoc.xls".
As reference take a look at the org.alfresco.repo.web.scripts.content.StreamContent & org.alfresco.repo.web.scripts.content.ContentGet classes.

Cheers, Erik

Re: How to send webscript response as file (file download box)

g_rathod — Fri, 23 Mar 2012 11:24:00 GMT

Hi Erik,

Thanks for quick reply.
Actually I am using "extends DeclarativeWebScript" so response is not available in it.
Sorry but I could not understand from given example you have suggested. Is there any more snippet which is used in DeclarativeWebscript ?

Re: How to send webscript response as file (file download box)

erikwinlof — Fri, 23 Mar 2012 11:33:09 GMT

Then I would suggest you extend the org.alfresco.repo.web.scripts.content.StreamContent instead of DeclarativeWebscript.
Take a look at how the org.alfresco.repo.web.scripts.content.ContentGet as an example.

Cheers,

:: Erik

Re: How to send webscript response as file (file download box)

g_rathod — Fri, 23 Mar 2012 12:42:48 GMT

Thanks Erik,
One more question, How my desc.xml looks like then ??

Example like :

<webscript>
  <shortname>Export Search Results</shortname>
  <description>Export Searching result in Advance Search</description>
  <url>/repository/exportcsv</url>
  <format default="json"></format>
  <authentication>user</authentication>
</webscript>‍‍‍‍‍‍‍

for file how it should be?

Re: How to send webscript response as file (file download box)

erikwinlof — Fri, 23 Mar 2012 12:54:09 GMT

Take a look at the desc file for ContentGet.java:

http://svn.alfresco.com/repos/alfresco-open-mirror/alfresco/HEAD/root/projects/remote-api/config/alfresco/templates/webscripts/org/alfresco/cmis/content.get.desc.xml

You should for example change your <format> declaration, to i.e. <format default="">argument</format>

Cheers, Erik

Re: How to send webscript response as file (file download box)

g_rathod — Fri, 23 Mar 2012 13:00:46 GMT

Hi Erik,
Thanks a lot.

Actually this helps. currently in declarative webscript,I thought of writing that csv file in same webscript class to some temp location.
and thought to send it as response.
Now I have two things remaining like how to write a file (temparary location tomcat/temp) and send stream as response locating our file, as you suggested.
so currently being stuck at this stage.

Re: How to send webscript response as file (file download box)

erikwinlof — Fri, 23 Mar 2012 13:09:20 GMT

Please take a look at the ContentGet implementation, in there you will be able to see how its done. I.e. look at

protected void streamContent(WebScriptRequest req, WebScriptResponse res, File file, Long modifiedTime, boolean attach, String attachFileName) throws IOException

to see who streaming from a file is done.

Cheers and good luck, Erik

Re: How to send webscript response as file (file download box)

g_rathod — Mon, 26 Mar 2012 06:22:29 GMT

Hi Erik,

Thanks, but what my option is, see when internally I am creating a file can't we expose it directly, here ContentGet implementation seems we need to first store it in alfresco repository and then populating stuffs.
because what I have in return of webscript is File object thats it.
As per implementation I saw in ContentGet is following :

I have checked

protected void streamContent(WebScriptRequest req, WebScriptResponse res, File file, Long modifiedTime, boolean attach, String attachFileName) throws IOException

which is also requiring following :
1) resourcePath
2) attach
3) attachFileName

Actually as I have only File to return. with No StreamId/ content props/attach….

<!– by object id –>
  <url>/cmis/i/{id}/content{property}?a={attach?}&amp;streamId={streamId?}</url>
  <url>/cmis/s/{store}/i/{id}/content{property}?a={attach?}&amp;streamId={streamId?}</url>
  <!– by path –>
  <url>/cmis/p{path}/content{property}?a={attach?}&amp;streamId={streamId?}</url>
  <url>/cmis/s/{store}/p{path}/content{property}?a={attach?}&amp;streamId={streamId?}</url>

  <!– alfresco style –>
  <url>/api/node/content{property}/{store_type}/{store_id}/{id}?a={attach?}&amp;streamId={streamId?}</url>
  <url>/api/path/content{property}/{store_type}/{store_id}/{nodepath}?a={attach?}&amp;streamId={streamId?}</url>
  <url>/api/avmpath/content{property}/{store_id}/{avmpath}?a={attach?}&amp;streamId={streamId?}</url>
  <url>/api/node/{store_type}/{store_id}/{id}/content{property}?a={attach?}&amp;streamId={streamId?}</url>
  <url>/api/path/{store_type}/{store_id}/{nodepath}/content{property}?a={attach?}&amp;streamId={streamId?}</url>‍‍‍‍‍‍‍‍‍‍‍‍‍

Re: How to send webscript response as file (file download box)

g_rathod — Mon, 26 Mar 2012 13:40:45 GMT

Hi Erik,

Finally I am able to use StreamContent as you said.
streamContent(req, res, tempFile, true, tempFile.getName());

where tempFile = file Object
true = attachment boolean

but sadly it wont show me save As or download box. inside tomcat no other errors are there.

Even using streamContent, do I need to set following ??

res.setContentType("application/csv");
res.setHeader("content-disposition","filename=test.csv");‍‍

Can't we download content without storing it to alfresco repository ???. It is currently stored in my alfresco/tomcat/temp

Re: How to send webscript response as file (file download box)

power — Tue, 27 Mar 2012 10:28:31 GMT

Hi Ghanshyam,

I have similar kind of issue, did you resolved that?
I am storing file in tomcat/temp but streamContent would not expose file to share side as download prompt.

Re: How to send webscript response as file (file download box)

alfsender — Tue, 08 Jan 2013 13:21:41 GMT

Hi All,

were you able to resolve this, coz i am doing the same thing to export file from Share. I tried with declarative webscript and Content Stream but i am not getting content pop-up to save/save-as file.

please provide your inputs, that will be really help full.

Thanks.

Re: How to send webscript response as file (file download box)

grg021 — Wed, 06 Mar 2013 05:31:49 GMT

hi, we're trying to the same as well. Has anyone got this down yet? we're using alfresco share 4.0.e.

Cheers.

Re: How to send webscript response as file (file download box)

mgupta — Mon, 20 May 2013 16:43:16 GMT

Hello,
Can you tell me how did you put a button to export advanced search results on the results screen

Re: How to send webscript response as file (file download box)

aleksczajka — Thu, 27 Nov 2014 17:44:23 GMT

Check this one out: https://wiki.alfresco.com/wiki/3.0_Web_Scripts_Kinds

Re: How to send webscript response as file (file download box)

aleksczajka — Thu, 27 Nov 2014 17:55:00 GMT

in case anyone still needs a response to this, here's how i did it…. all you need is a name.get.js and name.get.desc.xml and place them into your webScripts directory in Alfresco Share

name.get.desc.xml

three things to pay attention to: 1. "kind" attribute on the <webscript> tag, 2. empty "default" attribute on the <format> tag, 3. "required" content for the <transaction> tag


<webscript kind="org.alfresco.repository.content.stream"> 
<shortname>return file</shortname> 
<description>return a file</description> 
<url>/name/return/{name}url> 
<format default="">extension</format> 
<authentication>guest</authentication> 
<transaction>required</transaction>
</webscript> 
‍‍‍‍‍‍‍‍‍‍

name.get.js

I search for my file first by name, but, you can search on other things as well, tags, internal columns, categories, text, etc. Just take a look into luceneSearch


// perform search
var nodes = search.luceneSearch("@cm\\:name:\""+url.extension+".xml\"");

//stream the first document
model.contentNode = nodes[0];
‍‍‍‍‍‍‍

and that's it