- Setting up the Database
- Defining the Audience RolesMembers
- Separating Announcements based on Topic (Whitelist/Blacklist)
- Configuring the WYSIWYG Editor
- Changing Announcement List Sort Order
...
Anchor | ||||
---|---|---|---|---|
|
Setting up the Database
Edit the pom.xml to define the jdbc driver to be used.
Code Block <!-- The Default JDBC Driver used by the portlet --> <jdbc.groupId>org.hsqldb</jdbc.groupId> <jdbc.artifactId>hsqldb</jdbc.artifactId> <jdbc.version>2.2.9</jdbc.version>
Define your database details in src/main/resources/database.properties
Code Block ## Default configuration uses an in-memory database that will reset ## whenever you restart the portlet driver.class=org.hsqldb.jdbc.JDBCDriver driver.url=jdbc:hsqldb:mem:announce driver.username=sa driver.password= driver.validationQuery=select 1 from INFORMATION_SCHEMA.SYSTEM_USERS hibernate.dialect=org.hibernate.dialect.HSQLDialect
Anchor | ||||
---|---|---|---|---|
|
Defining
...
Audience
...
...
Members
If you have additional user groups (i.e, PAGS) that you need to send announcements to that are not listed in the default options, adding additional audience members is quite simple.
- Open src/main/webapp/WEB-INF/portlet.xml
Around line #210 you will see role definitions. Here you can add your additional audience roles you want as options.
Code Block language html/xml <!-- Do not change the role-name of this role, doing so may lock you out of your topics --> <security-role-ref> <role-name>Portal_Administrators</role-name> <role-link>Portal Administrators</role-link> </security-role-ref> <security-role-ref> <role-name>Everyone</role-name> <role-link>Everyone</role-link> </security-role-ref> <security-role-ref> <role-name>All_Logged_In_Users</role-name> <role-link>Authenticated Users</role-link> </security-role-ref> <security-role-ref> <role-name>Faculty</role-name> <role-link>Faculty</role-link> </security-role-ref> <security-role-ref> <role-name>Staff</role-name> <role-link>Staff</role-link> </security-role-ref> <security-role-ref> <role-name>Students</role-name> <role-link>Students</role-link> </security-role-ref>...
The changes above require a rebuild of the portlet and redeployment to the uPortal project
Rebuild Announcements portlet
Code Block language bash mvn clean package
Redeploy the portlet under the portal space and restart tomcat.
Code Block language bash ant deployPortletApp -DportletApp=/path/to/Announcements.war
Anchor | ||||
---|---|---|---|---|
|
Separating Announcements based on Topic
There may be occasions where you may wish to create multiple instances of the announcements portlet that only contain specific topics. This is very simple to do using the Whitelist and Blacklist feature in the portlet configuration.
WhiteList Feature
This feature is where you would specify the topic(s) you want to display in a given announcements portlet.
Note | ||
---|---|---|
| ||
EMERGENCY announcements will always be displayed in addition to the specified topics. |
Case Scenario:If I want an announcements portlet to display announcements with only the topic, "IT System Outages", that I had created, I would do the following:
- Register a new Announcements portlet and fill out the forms.
- When you get to the end you will be presented with a "Save" or "Save and Configuration" button. Click on the "Save and Configuration" button.
- Select "Whitelist" from the drop-down menu and type the topic(s) in the textarea field you want to appear. (topics should be on a separate line.)
- The resulting portlet looks like this:
BlackList Feature
This feature is where you would exclude a topic(s) but display the remaining topic options.
Case Scenario: If I want an announcements portlet to display all announcements except for my "All Campus" topic I created, I would do the following:
- Register a new Announcements portlet and fill out the forms.
- When you get to the end you will be presented with a "Save" or "Save and Configuration" button. Click on the "Save and Configuration" button.
- Select "Blacklist" from the drop-down menu and type the topic(s) in the textarea field you want to EXCLUDE. (topics should be on a separate line).
- The default before and after result (Note: "All Campus" is gone):
Anchor | ||||
---|---|---|---|---|
|
Configuring the WYSIWYG editor
...
The tinyMCE.init call in the JavaScript at the bottom of the page contains properties starting with theme_advanced_button
that control the displayed editor buttons. Each property corresponds to a button row, and each row is numbered appropriately. Buttons may be added to each row and ordered as desired. The available buttons are listed in the TinyMCE documentation, and the name "separator" may be used to separate buttons.
...