Liferay Portal Installation

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

  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/vf80/?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. 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 below.

  4. 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.

  5. Save viewsflash.properties.
  6. You can deploy ViewsFlash simply by placing the ViewsFlash.war file to the deploy directory located in the main Liferay directory. You can also use App Manager / Install to upload the ViewsFlash.war file.
  7. Perform the Post deployment configuration and troubleshooting steps in the ViewsFlash Installation page from step 1.
  8. After deploying the war file successfully, the Survey portlet will be deployed. Grant thee appropriate Roles the permission to Configure and Add to Page and the permission to View the Survey portlet.
  9. 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

  1. Add the following parameters to /etc/cogix/viewsflash.properties:

    appsecurity=user
    administrators=JoeBloggs,@Administrator

    In this example, JoeBloggs is the screen name of the default Liferay administrator. @Administrator means any user who is in the Liferay Administrator role. You can use any screen names and roles.
  2. Restart Liferay.

Continue with Using the portlet.