Marketplace portlet
| Info |
|---|
This page is still in progress - more to come. |
The marketplace portlet is a new way for users to find content faster and easier. Presented similarly to mobile app stores, users can search, review, and see more about an portlet than ever before.
This can be used in conjunction with the gallery/customize drawer or can serve as a replacement.
Screenshots of this portlet in action!
Initial View:
Intended feature: ability to filter by Category.
Intended change: replace "A-Z Index" with "See All", maybe in the number of results pull-down.
Intended change: defer "Most Popular" idea.
Clicking on the Title takes you straight to the portlet. Clicking on details takes you to the entry page.
...
By Default, every app will have an entry page. Check out these default entry pages...
Now take a look at a more robust entry page:
How to add screenshots
Add some screen shots in this format screen_shotx and corresponding captions as screen_shotx_caption.
...
Version History is added via portlet preferences in your portlet entity file. See example values below.
| Code Block |
|---|
<portlet-preference> <name>Initial_Release_Date</name> <readOnly>true</readOnly> <value>21-02-2010 00:04:00</value> </portlet-preference> <portlet-preference> <name>Release_Date</name> <readOnly>true</readOnly> <value>Feb 5, 2014<<value>15-09-2013 00:04:01</value> </portlet-preference> <portlet-preference> <name>Release_Notes</name> <readOnly>true</readOnly> <value>Responsive Design!</value> <value>Doesn't Break</value> <value>Adds the ability to have Screenshots</value> <value>Adds the ability for version notes</value> <value>Search works</value> <value>See your favorite apps</value> </portlet-preference> |
Initial Release Date is optional. Initial release date is a Joda Time "DateTime" field. The value of the preference should be "dd-MM-yyyy HH:mm:ss".
Release Date is optional. Release date is a Joda Time DateTime field. The value of it should be "dd-MM-yyyy HH:mm:ss".
...
The entry page will show related portlets. A related app is an app that belongs to the same category or is in a sub category of a given app. The related app section only appears when there are any related apps (ie, no empty list will ever appear) and the list is limited to five (configurable via a java field). The list of portlets shown is randomized, so it gives a little bit more life to the entry page.
How to limit what users can see in the initial view?
There are two portlet preferences that help.
| Code Block | ||
|---|---|---|
| ||
<portlet-preference>
<name>showAllPortlets</name>
<readOnly>true</readOnly>
<value>true</value>
</portlet-preference>
<portlet-preference>
<name>showManagedPortlets</name>
<readOnly>true</readOnly>
<value>true</value>
</portlet-preference> |
The showAllPortlets preference is false by default. This preference allows the marketplace to show all portlets regardless of permission to subscribe/manage. If set to false or the preference is not included, it will default to show only the portlets that you have permission to subscribe to.
The showManagedPortlets is true by default. This preference will add to the displayed set, portlets that a user can manage. Note, that if showAllPortlets is true, the showAllPortlets set will already include any managed portlets.
Proposed: Add another preference to hide certain admin portlets. So you can show all but a few (ex: Portal Administration)
Categories
Listed on every portlet's entry page is a list of categories that a portlet belongs too. Clicking any of the categories will send the user back to the initial landing page with the category clicked in the filter.
Categories are also available for viewing on the initial landing page. Clicking the category button will display all the categories that have portlets the user can view in the marketplace. Because uPortal ships with a 'ALL CATEGORIES' category, there is a portlet preference that can be set to hide this 'root' category. The default is to not show the 'root' category, so if this preference is not here, it won't show. Here is the portlet preference example, where showing the root category will not be displayed:
| Code Block | ||
|---|---|---|
| ||
<portlet-preference>
<name>showRootCategory</name>
<readOnly>true</readOnly>
<value>false</value>
</portlet-preference> |
Here is a screenshot showing the categories displayed on the landing page, after the category button is clicked:
Screenshot after the Entertainment category is clicked. Notice the filtering!
Featured Portlets!
In class org.jasig.portal.portlets.marketplace.PortletMarketplaceController is a static field:
private static String FEATURED_CATEGORY_NAME="Featured";
Any portlet with that as a category will become a "Featured" portlet. Featured portlets are highlighted on the main landing page. 0 featured portlets and nothing (including the label) is shown. If there is an odd number of featured portlets, the first appears in the middle, then the rest appears 2 per row. The label is in the message.properties file for easy changing.
Ratings!
Ratings are shown to the user on the entry page of a portlet. User can select 1-5.
...
Also, every portlet can be rated via the options menu! 1 rating per person per fname is allowed. When the rating star system is displayed, it shows what the user had previously rated. Of course, a user can always update their ratings and the appropriate places are updated.
Rating will (intended feature) also be included as a column in the portlets listing data-table so it can be sorted upon.
What's coming up next?
Jira Legacy
The submit button submits both the rating and the review without page refreshing! The submit button is disabled until the user gives a star rating. The text component is optional. There is a character remaining label to let the user know that only reviews up to 160 characters are allowed. The text turns red when the characters get under 10 remaining. The max length of reviews is configurable in this code block
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
package org.jasig.portal.portlets.marketplace;
import org.jasig.portal.portlet.dao.jpa.MarketplaceRatingPK;
public interface IMarketplaceRating{
public static final int MAX_RATING = 5;
public static final int MIN_RATING = 0;
public static final int REVIEW_MAX_LENGTH=160; |
Go Button!
The go button will send the user to the portlet, a very nice way to use the portlet.
Link Modal
The long link is auto generated. The short link is a portlet preference.
| Code Block | ||
|---|---|---|
| ||
<portlet-preference>
<name>short_link</name>
<readOnly>true</readOnly>
<value>http://goo.gl/ALBYpJ</value>
</portlet-preference> |
First Epic Completed
| Jira Legacy | ||||||
|---|---|---|---|---|---|---|
|
Where is the code so far?
...
The University of Wisconsin is currently in a redesign and is working towards the mockups pictured above (when they get there).
Timothy Vertein is actively working on this project at the UW.
Deferred ideas / features:
- "Popular", as a filter or sort, for some meaning of "popular" (most rendered? Most favorited?)
.
Is this the end?
No. UW has planned more improvements and is excited for other's suggestions and contributions.
What if I don't want to use this.
Turn off marketplace rating aggregation here by commenting these lines
| Code Block | ||||
|---|---|---|---|---|
| ||||
################################################################################
## ##
## Rating Aggregation Configuration ##
## ##
################################################################################
# Every Six Hours
org.jasig.portal.aggr.PortletRatingAggregatorImpl.AggregatePortletRatingsPeriod=22284000 |
| Code Block | ||||
|---|---|---|---|---|
| ||||
<task:scheduled ref="portletRatingAggregator" method="aggregatePortletRatings" fixed-delay="${org.jasig.portal.aggr.PortletRatingAggregatorImpl.AggregatePortletRatingsPeriod}" /> |
Turn off marketplace search results here by toggling the comment lines:
| Code Block | ||||
|---|---|---|---|---|
| ||||
<!--Toggle one of the next two via comment
Marketplace and PortletRegistry search are very similar. Marketplace provides searching of
portlet preferences marked as screen_capture_x and will include a link to the marketplace
entry and possibly more to come
-->
<!--
<bean class="org.jasig.portal.portlets.search.portletregistry.PortletRegistrySearchService"/>
-->
<bean class="org.jasig.portal.portlets.marketplace.MarketplaceSearchService" /> |