Liferay Portal Installation

These instructions install the Cogix Survey portlet and the ViewsFlash application in Liferay Portal version 5.

1. Create a directory /etc/cogix at the drive's root level; if on Windows, use the drive that Liferay is installed on, e.g.: C:\etc\cogix.
   
2. Create /etc/cogix/viewsflash.properties using a text editor.
   
   data=/etc/cogix (on Windows, use C:\\etc\\cogix)
   license=who=your_company;......;licensekey=63-85-90-91-0E-07-2E-AC-E7-9A-F1-BB-17-C5-AB-87-
   
   For the license parameter above, request a license from Cogix. If you don't have a key, omit the license parameter. The software will add an "Evaluation Copy" message, and will work for 30 days.
   
   For additional parameters, see http://www.cogix.com/docs/vf60/?Installation.html. Do not follow the step by step installation procedure; follow these steps instead.
   
   NOTE: If you don't want to use /etc/cogix in the data parameter, then unpack the ViewsFlash.war file, modify WEB-INF/web.xml to include a propertiesfile init-param that points to where you want to store viewsflash.properties, and repack the ViewsFlash.war file. The web.xml file includes a commented out section that does this. You can also specify any parameters in viewsflash.properties as init-param elements in web.xml and avoid using viewsflash.properties altogether.
   
3. If running Liferay Portal on Tomcat, you MUST add emptySessionPath="true" to your Connector in server.xml and restart Tomcat. This is required for portlets and web applications to share session data.
4. SECURITY NOTE If you plan to use fine-grained User Security, first deploy the portlet without security, and once it is working follow the instructions for Single Sign On.
   
   
5. You can host ViewsFlash on a database immediately, or you can migrate to a database later. To use an existing JDBC Named Data Source, include lines like this in viewsflash.properties, replacing ViewsFlashDatabase with the name of your data source:
   
   database=MySQL
   datasource=java:comp/env/ViewsFlashDatabase
   
   If using a database other than MySQL, put that database vendor name in the 'database' parameter. For example; Oracle, MSSQL, or DB2. See Database Installation for more database options. The META-INF/context.xml file contains commented out examples of JNDI datasources for Oracle and MySQL configured at the context level for Tomcat. context.xml also contains configurations needed for Single Sign On. Please refer to Single Sign On.
   
   
6. Save viewsflash.properties.
7. This installation gives the test@liferay.com user the right to configure the Survey portlet. To enable different users to configure the portlet edit the /ViewsFlash/WEB-INF/portlet.xml and add the "User id" values to the admin init-param. Multiple user id's must be separated by commas. Save portlet.xml.
8. Log in as the Liferay portal administrator. From the main menu, select "Add Application":
9. Expand the "Admin" selection, and choose the "Plugin Installer".
10. In the "Plugin Installer", select "Upload File".
11. Using the "Browse..." button, find the ViewsFlash.war file, and enter "ViewsFlash"  in the "optional context" text box.  Click "Install".
12. When the installation is complete, click the "Return to Full Page" link in the upper right of the "Plugin Installer" box.
13. The ViewsFlash portlet, called "Survey", can be found under "Undefined".
14. Perform the Post deployment configuration and troubleshooting steps in the ViewsFlash Installation page from step 1.
15. If you decide to add database support later, include the appropriate parameters in viewsflash.properties as described above, and restart Liferay. All data will be migrated to the database automatically. Check the viewsflash log at /etc/cogix/viewsflash.log for any error messages before continuing.

Updating

To update survey portlet and ViewsFlash application with a new version from Cogix, repeat the installation steps above with the new ViewsFlash.war file and restart Liferay.

Single Sign On

This installation procedure installs the ViewsFlash application and portlet without security. Follow these steps to enable application security and access controls when using Tomcat or JBoss.

1. Make sure that Single Sign On (SSO) is enabled across web applications. Do this by uncommenting the following SSO valve in {tomcat-home}/conf/server.xml:
   <Valve className="org.apache.catalina.authenticator.SingleSignOn" />
   

2. In the search field of the Enterprise Admin portlet, enter the login or screen name of the administrative account.  In the resulting list of users, click the "Screen Name" field.  From the detailed user information displayed next, take note of the "User ID". 
   
3. Add the following parameters to /etc/cogix/viewsflash.properties:
   
   appsecurity=user
   administrators=User ID noted above
   
   For exampe; administrators=2 will make the test@liferay.com user a ViewsFlash administrator. test@liferay.com is the portal administrator in the default Liferay installation.
4. Review the deployed {tomcat-home}/webapps/ViewsFlash/META-INF/context.xml file. Uncomment the Realm element.
5. Create {tomcat-home}/webapps/ROOT/WEB-INF/classes/portal-ext.properties (if it doesn't already exist) and add the following property:
   portal.jaas.enable=true
   
   
6. Restart Tomcat. Note, SSO works only when Liferay is accessed using the server's domain name.

Setting rights to the Survey portlet

1. In the Enterprise Admin portlet, click on the Plugins tab, then click on the Portlets tab.
2. Look for the Survey portlet and click it:
   
3. Enter the role Power User in the roles allowed box. A Survey portlet is typically put on a page by an administrator such as a Power User. You may want to use Administrator instead, or both.
   

Continue with Using the portlet.