|Extension Point||Surf Dashlets (It is recommended to use Aikau Dashlets instead)|
|Architecture Information||Share Architecture.|
The following picture shows a User Dashboard with a number of Dashlets, such as My Sites and My Tasks:
You can implement your own custom dashlets that can be added to either the User Dashboard or the Site Dashboard.Creating a Surf dashlet is the same thing as creating a Surf web script. Before continuing read through the Surf Web Scripts section.
The controller of the dashlet presentation web script will usually call a Data web script on the repository side to get the content that should be displayed in the dashlet.
Let's look at an example of a custom dashlet, the following picture shows a Member Directory dashlet that can be used to search the User/People directory:
This dashlet is implemented using a presentation web script, which in turn uses a Data web script to get the people matching the Search Filter parameter. The following picture illustrates:
In this case we have a Spring Surf Web Script on the Share side that will, in its controller, call a repository web script (that is Data Web Script) to get a list of person records in JSON format. The controller looks something like this:
// Get args from the Share page URL var filterValue = page.url.args["filter"]; var connector = remote.connect("alfresco"); var peopleJSONString = connector.get("/api/people?filter=" + filterValue); // create json object from data var peopleJSON = jsonUtils.toObject(peopleJSONString); model.people = peopleJSON["people"];
The controller makes use of a special root object called remote, which is used to connect to a remote service, such as the repository, and get data. The JSON data is returned from a repository web script) (that is, a Data web script), which in its controller uses the public API to fetch person information matching passed in Search Filter (that is, filter).
The repository web script uses a root object called people to search for person info. This root object is Alfresco Community Edition specific and is only available in repository web scripts.
Now, to create a dashlet web script you also need a descriptor, which is defined in XML and looks something like this:
<webscript> <shortname>Member Directory</shortname> <description>Provide Search of people and display in a list</description> <family>user-dashlet</family> <url>/components/dashlets/member-directory</url> </webscript>
The descriptor looks like any other web script descriptor except the family parameter, which can have the following values:
The Dashlet UI needs to be implemented in the web script template as follows:
member.directory.dashletName=Member Directory member.directory.searchFilter=Search Filter member.directory.searchResult=Search Result
|Deployment - App Server||
Best practice is to put the files in a directory that explains what they are for, such as for example:
|Deployment - SDK Project||
You are here
Sending feedback to the Alfresco documentation team