Tuesday, 18 August 2009 20:57

Configuring the Journal Application in Liferay Portal

Rate this item
(2 votes)

Configuring the Journal Application


Now we will study the configuration settings for the Journal portlet at the application level. When you click the application-configuration icon, you will see four tabbed options:
 
• Setup: Lets you set various e‑mail formats
• Permissions: Lets you set permissions for different user roles
• Export/Import: Facilitates the export and import of data
• Sharing: Facilitates application sharing

Setup

Under the Setup option , you can set up the formats for various e‑mail messages, such as these:
 
• Email From
• Article Denied Email
• Article Granted Email
• Article Requested Email
• Article Review Email
 

Email From

In the Email From tabbed option, you can set the sender information for all the applicationgenerated e‑mail messages. In particular, you enter the sender’s name and e‑mail ID.

Article Denied Email

The Article Denied Email tab allows you to set the format for the e‑mail message that communicates an article rejection. If you decide to reject an article because its contents are unsuitable, the application sends an automated message to the author using the format specified on this screen (see Figure 10-24). The message format uses several predefined fields, which are listed at the bottom of the screen.

Article Granted Email

The Article Granted Email tab lets you define the format for the e‑mail message that gets sent to a user whose article has been accepted for publication. Its settings resemble those for the Article Denied Email screen.

Article Requested Email

When a user submits an article for publication, the application generates a message for the portal administrator indicating that the user has requested an article approval. In the notification message, the author can mention the article’s location (URL), ID, version, title, and any other relevant information. You can define the format for this notification message in the Article Requested Email tabbed option.

Article Review Email

You might want multiple reviewers to read and approve any submitted article. You use the Article Review Email screen to set up the e‑mail message requesting a review.

Permissions

In the Permissions tabbed option, you can set several permissions for the Regular and Community roles.

Regular Roles

Under the Regular roles, you have four types of users:
 
• Administrator
• Guest
• Owner
• Power User
• User
 
A guest user has only two types of permissions: View and Configuration. The View permission is granted by default. Granting the Configuration permission allows the user to perform various configuration activities.

An administrator, owner, power user, and ordinary user can obtain several types of permissions:
 
Add Article: Allows the user to add a new article
Add Feed: Allows the user to add an article feed
Add Structure: Allows the user to create a new structure
Add Template: Allows the user to create a new template
Approve Article: Allows the user to approve a submitted article
Configuration: Allows the user to perform various configuration tasks
View: Allows the user to view articles 

Community Roles

Under Community roles, there are three types of users:
• Administrator
• Member
• Owner
 
All three types of users have access to all the permissions discussed in the “Regular Roles” section. These are Add Article, Add Feed, Add Structure, Add Template, Approve Article, Configuration, and View.

Export/Import

 
The Export/Import tabbed option facilitates the export and import of the journal-article database pertaining to the current community. When you click this tabbed option, you will see the screen shown in Figure 10-25.

 
Figure 10-25. Setting up fields for export
 
On this screen, you can select the various fields you wish to export to the external database. The file name is specified in the LAR file-name edit box. By default, several fields are marked for export; you can uncheck any fields you don’t want. You can also opt to export data only in a specified date range.

The Import tab allows you to select fields you wish to import into the new instance of the Journal application. While importing the data, you can choose to mirror the data or copy it as new data. Likewise, if a user is not defined in the new instance of the portal, you can choose to use your ID in place of the missing person’s ID. Alternatively, you can decide to use your ID in all cases, irrespective of whether the user is defined in the new system.

Sharing

The Sharing option produces the code that you can embed in other web sites so you can make this application available elsewhere. It also allows Facebook sharing of the application.

Creating Template-based Articles

Creating the Structure

Use the following steps to create the new structure:
1. Open the Journal application.
2. Select the Structures tab and click the Add Structure button
3. Mark the Autogenerate ID check box.
4. Enter 52-week analysis data in the Name field.
5. Enter This defines the structure for the 52-week analysis report in the Description field.
6. Leave the default settings in the Permissions section.
7. Using the Add Row button repeatedly, add several fields to the structure with the following names and content types.
a. Name: Info; Type: Text
b. Name: Symbol; Type: Text
c. Name: High; Type: Text
d. Name: Low; Type: Text
e. Name: 52WeekHigh; Type: Text
f. Name: 52WeekLow; Type: Text
8. You can rearrange the rows by using the up and down arrows, if desired
9. Click the Launch Editor button to verify that the structure you created matches the one shown in Listing 10-1.

Listing 10-1. XML Document for the Created Structure
10. Click the Save button to save your edits. Next, you will create the article template based on this structure.

Creating the Template

To create the new template, use the following steps:
 
1. Return to the main screen of the Journal application, if you have not done so.
2. Select the Templates tab and click the Add Template button
3. Mark the Autogenerate ID check box.
4. In the Name field, enter 52-week article template.
5. In the Description field, enter This template defines the article structure for a 52-week analysis report.
6. Leave Cacheable checked (its default state).
7. Click the Select button to the right of the Structure label and select the previously defined 52-week analysis data structure from the displayed list of structures.
8. Select XSL from the Language Type drop-down list. You will use the XSL transformation to define the document formatting.
9. In the Script edit box, select the file called 52week.xsl by using the Browse button. Note that you do not have this file on your machine yet; you must enter the code from Listing 10-2 in any of your favorite text editors and store it in a file called 52week.xsl.
Listing 10-2. The XSL Transformation Document
Listing 10.2 -Continuation
10. Leave the rest of the fields at their default settings.
11. Click the Save button to save your edits.
12. Click the Return to Full Page link to return to the main screen of the Journal application.

Now, you and your community users can use this template to create journal articles.

Creating Articles

To create a new article based on a template, use the following steps:
 
1. Navigate to the Journal application main screen, if required.
2. Select the Articles tab and click the Add Article button .
3. Enter IBM Stocks in the Name field.
4. Click the Select button to the right of the Template item in the Form and Presentation box on the right side of the screen.
5. Select 52-week article template from the list of displayed templates. This is the template you just created.
6. Note the changes on the left side of the screen. The default editor changes to the list of fields you had defined in the 52-week analysis data structure associated with the selected template.
7. Enter the following data in the displayed fields:
a. Info: My views on IBM stocks
b. Symbol: IBM
c. High: 90.20
d. Low: 86.33
e. 52WeekHigh: 130.93
f. 52WeekLow: 69.50
8. Leave all other fields on this screen at their default values.
9. Select the article’s category type from the Categorization box on the right side of the screen.
10. Click the Save and Approve button to publish the article.
11. Note that the Status changes to Approved (see the Status column in the list of articles).
12. To preview the article, click its Actions button and select Preview. You will see the screen shown in Figure 10-26. This is what your users will see when they open the article in their portal window.
 

Using the Journal Articles Application

The Journal Articles portlet allows the user to view articles of a certain type from the repository, such as Announcements or Blogs. As an administrator, you will decide on what the user will see. To use this portlet on our ISI portal, follow the steps listed here:
1. Log on using your Administrator account.
2. Navigate to the Dynamic public page you created earlier in this chapter, or move to any other page where you wish to add this application.
3. Select the Add Application menu option.
4. Select the Journal Articles application under the CMS category.
5. Add the application to the portal page using the Add link.
 
 
Before your users start using the Journal Articles application, an administrator needs to set it up. To set up the application, follow these steps:
 
1. Click the application-configuration icon.
2. Choose the following options on the setup screen:
a. Community: From this drop-down list, you need to select the community from all the available communities on your portal. The articles pertaining to the specified community will be displayed in the application portlet.
b. Article Type: Select the article type. Note that a user can define his own type, after which it will appear in the selection list. Here are some examples of Liferay’s predefined article types:
i. Announcements
ii. Blogs
iii. General
iv. News
v. Press Release
vi. Test
c. Display URL: Leave this as the default value of Maximized.
d. Display per Page: This option allows you to select the number of articles to be displayed in the list. The default value is 5.
 
e. Order By Column: Here you can decide the sort order for the list of articles. You can sort the list by one of these parameters:
i. Display Date
ii. Create Date
iii. Modified Date
iv. Article Title
v. ID
f. Order By Type: This field determines whether the sort order is ascending or descending.
3. Save the edits by clicking the Save button.
4. Click the Return to Full Page link to go back to the main application screen.
 
You will now see the list of articles displayed in the application’s main window

Using the Journal Content Application

To use the Journal Content application on our ISI portal, follow the steps listed here:
 
1. Log on using your Administrator account.
2. Navigate to the Dynamic public page you created earlier in this chapter, or move to any other page where you wish to add this application.
3. Select the Add Application menu option.
4. Select the Journal Content application under the CMS category.
5. Add the application to the portal page using the Add link.
6. At the bottom-left corner of the application screen, you will find two icons: one for selecting an article to view, and one for adding a new article.
7. If you do not have any existing articles, click the Add Article icon to open the article editor.
8. Create a new article, then click the Save and Approve button.
9. When you return to the main application screen, you can select the article for viewing
10. You can edit the displayed article by clicking the Edit icon displayed at the bottom-left corner of the application screen.
Now you’ll configure Journal Content at the application level. When you click the application-configuration icon.

You will see the list of articles displayed on the bottom of the setup screen. You will also see a list of setup options in the center of the screen:
 
• Show Available Locales: Checking this box results in the display of all locales in which the application is available.
• Enable Ratings: Selecting this option results in the display of ratings on the main application screen.
• Enable Comments: Selecting this option enables the user to comment on the current article.
• Enable Comments Ratings: This setting allows the user to rate the comments on the article.

Using the Journal Content Search Application

Journal Content Search is an easy-to-use application that allows the user to locate an article from a huge database. To use this application on your portal, follow the steps listed here:
 
1. Log on using your Administrator account.
2. Navigate to the Dynamic public page you created earlier in this chapter, or move to any other page where you wish to add this application.
3. Select the Add Application menu option.
4. Select the Journal Content Search application under the CMS category.
5. Add the application to the portal page using the Add link.
6. To use the application, type your search criterion in the edit box and click the magnifying-glass icon. A list of articles matching the search criterion appears onscreen. 7. Click an article name in the list to view it.
 
Last modified on Wednesday, 19 August 2009 09:57
Vicky

Vicky

E-mail: This e-mail address is being protected from spambots. You need JavaScript enabled to view it