牛牛口诀大全

書名： Learning Alfresco Web Scripts
作者名： Ramesh Chauhan
本章字數： 517字
更新時間： 2021-08-05 17:28:05

Extending the first web script to use the controller

The web script framework in Alfresco makes it easy to have a clear separation of concerns by following a model-view-controller pattern in order to develop a web script. All the business logic resides in the controller and it is possible to have multiple views as required to return the response in different response formats supported by the web script framework in Alfresco. The model object is a data structure used to pass information from the controller to the view. The controller populates the model object with the required data and passes it to the view to generate the response.

In the first web script, we created a basic and simple web script, which just renders the output without interacting with the Alfresco repository. Ideally, any processing related to business logic such as querying the Alfresco repository, creation of content, updating content, deleting content from the repository, and executing actions should be done in a controller. A controller could be a server-side JavaScript or a Java-based controller.

Let's extend our first web script to add a controller to get an understanding about how the controller populates and passes data to FreeMarker template and how FreeMarker template uses the model data to generate the response:

Log in to Alfresco Share UI.
Click on the Repository link from the top header.
Go to Data Dictionary | Web Scripts Extensions.

Edit the descriptor file helloworld.get.desc.xml as follows:

<webscript>
  <shortname>Hello World</shortname>
  <description>First webscript Hello world</description>
  <url>/helloworld?name={argumentName}</url>
  <authentication>user</authentication>
</webscript>

Create a new file named helloworld.get.js with content as follows:
```
model.email="Ramesh.chauhan@cignex.com";
```

Edit the FreeMarker template helloworld.get.html.ftl as follows:

<html>
  <body>
    <p>Hello! ${args.name}.</p>
    <p>email address: ${email}</p>
  </body>
</html>

Go to http://localhost:8080/alfresco/service/index and click on the Refresh Web Scripts button.
Now, hit the URL http://localhost:8080/alfresco/service/helloworld?name=Ramesh to execute the web script. It will ask for user credentials. Provide user credentials and you should see the response as:
Hello! Ramesh.
email address: Ramesh.chauhan@cignex.com

This is how we can have a controller added in a web script in a simple way. In the preceding example, we hard-coded the e-mail address to be returned in the web script response. We did not have any interaction with the Alfresco repository. We just populated the model object and passed it to the FreeMarker template from the server-side JavaScript controller.

Note

Model is basically a root object that Alfresco makes available for data sharing to happen between the server-side JavaScript controller and FreeMarker template view.

You can modify the controller to get the e-mail address dynamically retrieved from the Alfresco repository based on the name argument received. With the help of Alfresco JavaScript API, you may first retrieve the user from the repository based on the name argument and then fetch the e-mail address of the user. In a server-side JavaScript controller, you can leverage on available Alfresco JavaScript API to interact with the repository. This way, we can have a web script render a response based on the data retrieved from the Alfresco repository.

Note

In a server-side JavaScript controller, you can leverage on available Alfresco JavaScript API to access the Alfresco repository and perform business logic as required.

官术网_书友最值得收藏!

Learning Alfresco Web Scripts

Extending the first web script to use the controller

Note

Note