topic Re: UI development for my application in Alfresco Archive

UI development for my application

shanmmugarajak — Wed, 18 Jan 2006 11:13:47 GMT

Hi,I am new, using Alfresco, I find this tool awesome. We decided to go with developing our application using Alfresco as the tool itself provides various features we are looking to, like search, uploading, search engine etc.Is it possible to develop UI (JSP) to use it in Alfresco. If so can anyone

Re: UI development for my application

rdanner — Wed, 18 Jan 2006 18:54:01 GMT

Hi,

I am new, using Alfresco, I find this tool awesome. We decided to go with developing our application using Alfresco as the tool itself provides various features we are looking to, like search, uploading, search engine etc.

Is it possible to develop UI (JSP) to use it in Alfresco. If so can anyone walk me through?

Any sample third party application code available, that using Alfresco?

Thanks

Are you looking to build a completely separate application on top of alfresco? then the answer is yes

Are you looking modify the existing application on top of alfresco repository? then the answer is yes

If you are going to build a new app on top of the repository and keep the webclient as an admin tool (thats what we are up to), then you need to decide how that is going to happen. We are planning on remoting to the actual repository, treat it as a resource.

In such a case you have a bunch of options
JCR
JCR over RMI
Alfresco remote API
Alfresco web services

Re: UI development for my application

shanmmugarajak — Thu, 19 Jan 2006 03:46:14 GMT

Hi Russ,

Thanks for your efforts to reply. I actually wanted to build an application on top of Alfresco i.e. using Alfresco API, its features like search, upload, rule engine etc.

The user will need a interface to access these services, I want to first bother and decide on how to first address this issue of building a UI to use these services - kind of JSP which will trigger the services based on the user action. My question is, in case of triggerring such an action will call for coding Alfresco API's am I right?

Now can any one help me with your knowledge on how to go about building a UI (that doesn't expose Alfresco usage - like logo etc, but then my own logo, page coloring etc) and then from there trigerring a Alfresco utility service like search, uploading file, rule engine etc.?

Thanks
Raja

Re: UI development for my application

rdanner — Thu, 19 Jan 2006 04:01:48 GMT

Hi Russ,

Thanks for your efforts to reply. I actually wanted to build an application on top of Alfresco i.e. using Alfresco API, its features like search, upload, rule engine etc.

The user will need a interface to access these services, I want to first bother and decide on how to first address this issue of building a UI to use these services - kind of JSP which will trigger the services based on the user action. My question is, in case of triggerring such an action will call for coding Alfresco API's am I right?

Now can any one help me with your knowledge on how to go about building a UI (that doesn't expose Alfresco usage - like logo etc, but then my own logo, page coloring etc) and then from there trigerring a Alfresco utility service like search, uploading file, rule engine etc.?

Thanks
Raja

Raja,

In this case it is pretty simple. Afresco view is JSF. The JSF is done in this case with JSP files. You can "work-over" the existing jsp files to do whatever it is that you want. Or you can write a whole new set of JSP files.

Backing up the JSP files is a set of "backing beans" these beans then map down in to various other service beans provided by spring.

If what you need can rely on an existing backing bean then you have no issues, just use the existing backing bean. look in the faces-config.xml and spring context xml for bean defintions.

If you create forms that require different backing beans then you will need to do coding. You will need to get familiar with alfresco / spring and to some extent JSF.

There is also the ability to use templates in alfresco and this will possibly provide some mileage for you. It sounds as though you are mustly concerned with removing branding.

I have not looked too see how much of alfresco style and branding are controlled by style sheets and configuration but there is a strong possibility that this is the case. If it is only look and feel in terms of branding and colors you are looking to change then I suggest you look to see (or one of alfresco guys can tell you) how to change what config/stylesheet.

Re: UI development for my application

shanmmugarajak — Thu, 19 Jan 2006 04:31:59 GMT

Hi Russ,

Buddy thanks a lot for your immediate content-full response.

Ya I am aware of template, I will surely work on your suggestions, decide on the appropriate and get back.

Meanwhile, if any of the Alfresco guys as you told can put their pointers, to add your suggestion, on how to change the template to add our specific logo, style etc will be good to our Alfresco community.

Alfresco guys is it possible? Do I sound reasonable for our good?

Thanks
Raja

Re: UI development for my application

davidc — Thu, 19 Jan 2006 10:59:54 GMT

You will find the Web Client css and logos in (within the source bundle):

/projects/web-client/source/web/css
/projects/web-client/source/web/images

Re: UI development for my application

hsp — Thu, 19 Jan 2006 11:20:35 GMT

Using to advantage in this topic, I would like to know if is possible to do an application web (MVC) with jsp/struts/facades, using the alfresco core. How could it be, any thoughts?

Re: UI development for my application

davidc — Thu, 19 Jan 2006 11:33:32 GMT

Yes, you should be able to use any Java ui toolkit against the Alfresco java API - the API documentation can be found at:

http://www.alfresco.org/mediawiki/index.php/Alfresco_Content_Management_Java_API

Re: UI development for my application

shanmmugarajak — Mon, 23 Jan 2006 06:28:32 GMT

Hi,

In line with my previous doubt, I attempted the following to change login.jsp file available (I also restarted the server)

1. In webclient.properties file available at web-client\config\alfresco\messages, I modified username property value from "User Name" to "User Id", it is not getting reflected!

2. In login.jsp I modified the image - <%=request.getContextPath()%>/images/logo/AlfrescoFadedBG.png); to <%=request.getContextPath()%>/images/logo/cglib.png), this image change is also not getting reflected!

Is there any general procedure, so as to make these chagnes reflect, like changing some configurationi file etc. If any procedure exist, does that hold true for any modificaton?

Any example code online or documentation that walks through a customized application using Alfresco?

Thanks
Raja

Re: UI development for my application

gavinc — Mon, 23 Jan 2006 10:08:33 GMT

Hi,

Did you change the files within the Tomcat webapps folder or are you changing the files in an area you extracted from the nightly source or SVN?

If it's the former re-starting the server should pick up the changes. If it's the latter you will need to rebuild the WAR file and re-deploy and re-start the server to see the changes. You can use the "incremental-tomcat" target in the Ant build script to achieve this.

Changes to images can also be 'hidden' in Firefox due to it's cache, try refreshing the page with CTRL+R, or if that doesn't work clear the cache from the options panel.

Re: UI development for my application

shanmmugarajak — Mon, 23 Jan 2006 10:45:03 GMT

Hi Gavin

I am using JBOSS version. I have modified the login.jsp in the space which I have extracted from internet. How do I go about redeploying it in the JBoss server?

Thanks
Raja

Re: UI development for my application

gavinc — Tue, 24 Jan 2006 09:05:14 GMT

You need to go to <alfresco>/common and run the ant script in there as follows:

ant build-jboss‍

You will also need to setup a JBOSS_HOME environment variable to point to the JBoss area i.e.

JBOSS_HOME=<alfresco>/jboss‍

This should rebuild everything and re-deploy the WAR file to JBoss. You will also need to restart JBoss.

Re: UI development for my application

hsp — Tue, 07 Feb 2006 19:45:35 GMT

Yes, you should be able to use any Java ui toolkit against the Alfresco java API - the API documentation can be found at:

http://www.alfresco.org/mediawiki/index.php/Alfresco_Content_Management_Java_API

In the documentation above, says:
"…
There are three approaches to accessing the interfaces in your own code:

   1. Use standard Spring dependency injection (recommended, if your client code is also Spring based)
   2. Manual access via the Spring getBean() method
   3. Indirectly via Alfresco's ServiceRegistry

Spring provides excellent documentation on how to bind Beans together, so that won't be duplicated here.
…"

In other words, I must make my web application using spring framework, is it right?
May I make my web application using struts framework, and placing the /project/jcr and /project/remote-api files inside my context application?
Which folders have I to insert into my context/WEB-INF/src to do my web application using Alfresco like API….?

Sorry if these questions are too basic for you guys…
Regards
Helio

Re: UI development for my application

rdanner — Wed, 08 Feb 2006 00:27:08 GMT

Yes, you should be able to use any Java ui toolkit against the Alfresco java API - the API documentation can be found at:

http://www.alfresco.org/mediawiki/index.php/Alfresco_Content_Management_Java_API

In the documentation above, says:
"…
There are three approaches to accessing the interfaces in your own code:

   1. Use standard Spring dependency injection (recommended, if your client code is also Spring based)
   2. Manual access via the Spring getBean() method
   3. Indirectly via Alfresco's ServiceRegistry

Spring provides excellent documentation on how to bind Beans together, so that won't be duplicated here.
…"

In other words, I must make my web application using spring framework, is it right?
May I make my web application using struts framework, and placing the /project/jcr and /project/remote-api files inside my context application?
Which folders have I to insert into my context/WEB-INF/src to do my web application using Alfresco like API….?

Sorry if these questions are too basic for you guys…
Regards
Helio

If you are going to run the repository locally, then you need to start the spring context that loads it up. You can use whatever presentation layer you want. I am sure there is a Struts Spring integration. I just cant remember what it is called. But it exists.

If you run the repository remotely you can attatch to it from the application using the alfresco webservices or some other remoting technology.

Depending on your setup you can also bind the repository to JNDI and have applications look up a reference.

There are a lot of options. What are you looking to build? I dont think there is one formula that fits all.

Re: UI development for my application

hsp — Wed, 08 Feb 2006 12:04:11 GMT

We have a framework, based on struts/hibernate, where all the web applications we do/have are created using this framework. The security configuration system was also built using this framework. So, I don't know if it is possible to build my web application (for Content Manager) using what Alfresco offers.
My point is like someone already posted in this forum, in struts framework we inform the actions and beans the jsp will call, but there isn't all the file configurations that have in the Alfresco, so I don't know what files of Alfresco (souces and configuration) I will insert into my context to use at least the basics services of CM works. We have to do our soluction based on Alfresco, in this way it will be easier to maintenance in the future by ourself.
Would you realize what I mean?

Regards
Helio

Re: UI development for my application

rdanner — Wed, 08 Feb 2006 14:19:04 GMT

We have a framework, based on struts/hibernate, where all the web applications we do/have are created using this framework. The security configuration system was also built using this framework. So, I don't know if it is possible to build my web application (for Content Manager) using what Alfresco offers.
My point is like someone already posted in this forum, in struts framework we inform the actions and beans the jsp will call, but there isn't all the file configurations that have in the Alfresco, so I don't know what files of Alfresco (souces and configuration) I will insert into my context to use at least the basics services of CM works. We have to do our soluction based on Alfresco, in this way it will be easier to maintenance in the future by ourself.
Would you realize what I mean?

Regards
Helio

This link may be useful to you.
If you are going to bundle alfresco under your application you need atleast all of the xml files that ship with the alfresco repository. If there are "beans" you want to use from the webclient, then you need to bundle those xml files as well. At the moment it sounds like you are looking to leverage the repository not the UI portion of alfresco under your application.

http://struts.sourceforge.net/struts-spring/

I hope this is helpful to you

Re: UI development for my application

hsp — Tue, 14 Feb 2006 10:42:41 GMT

Which API provides all services found in Alfresco UI (or almost, like categorization, forum, versioning, aspects). If I am building my web client with struts, I'll need to place what tree of API into it, what files of Alfresco API depends and are needed to be placed into my application too?
I mean, if I want to do my UI with struts and place the api files into my context folder:
If I want to use the alfresco api which files are needed, or eigther if I want to use the repo api which files…?
Which api will provide the services I found in the Alfresco UI, or almost them?

Thanks in advance
Helio

Re: UI development for my application

rdanner — Wed, 15 Feb 2006 08:33:56 GMT

Which API provides all services found in Alfresco UI (or almost, like categorization, forum, versioning, aspects). If I am building my web client with struts, I'll need to place what tree of API into it, what files of Alfresco API depends and are needed to be placed into my application too?
I mean, if I want to do my UI with struts and place the api files into my context folder:
If I want to use the alfresco api which files are needed, or eigther if I want to use the repo api which files…?
Which api will provide the services I found in the Alfresco UI, or almost them?

Thanks in advance
Helio

Hi Helio,

Have you tried to make a simple spring / struts application? I did a little reading and the link I presented in the last post is actually quite stale. Spring has included support for struts for some time (since version 1.0.1 or in that release space.) Check the http://www.springframework.org website for information and sample applications.

If you have not made a simple application that proves out for yourself, I would start there. It will give you the basic mechanics for moving forward with alfresco.

I like to think of the web client as the candy shell on alfresco. It is heavily spring based underneath. Once you have a struts application invoking and referencing bean beans from spring you have the foundation.

Next you will look for the API of alfresco. The web client uses the Local Native alfresco API. This API is probably the easiest to get started with for one reason…. The web client is a good example of how to use the API.
You can't beat a working example….

The web client will take some digging on your part. You will need to learn where you are looking at code that addresses JSF concerns and where you are looking at the app. If you have done JSF this is a non issue and if you have not then… you will figure it out if you put some time to it. JSF on the consumer side is pretty obvious.

I would bet that you need (at the very least), the files from the core and repository portions of the source base. This IS the heart of alfresco.

The web client will be your example but only portions of it would probably show up in your application so it doesn't make good sense to include that stuff off the bat.

Pull in the repository.jar. You will notice all of the X-context.xml files. Once you have built a spring / struts application you will see how to incorporate these files in to your application.

-R