Installation

Prerequisites

Standalone Installation (single user environment)

  • If running Collect offline in a single-user environment, follow these instructions. 

Windows systems 

  • Download the installer: Collect installer for Windows systems  
  • Run the .exe file and follow the instructions on the screen. Collect will be installed by default into c:\OpenForis\Collect and all the settings and data will always be stored under your user folder, e.g. c:\Users\YOUR_USERNAME\OpenForis\Collect. 
  • If the installation completes successfully, you will have a group of shortcuts in the start menu, Open Foris Collect. 

 Start Collect 

  • In the start menu, select "All programs", then go into Open Foris Collect folder and select Launch Open Foris Collect
  • The Collect Control Panel should appear; continue following the instruction on how to use the control panel
  • If a message from Windows Firewall appears saying that Java is trying to access the network, allow it 

Linux systems

  • Download the installer: Collect installer for Linux systems 
  • Run the .run file as a super user and follow the instructions on the screen. Collect will be installed by default into ~/OpenForis/Collect.
  • If the installation completes successfully, you will have 2 icons in the Desktop, Launch Open Foris Collect and Update Open Foris Collect 

Start Collect

  • Double click on the Launch Open Foris Collect icon in the deskop 
  • The Collect Control Panel should appear; continue following the instruction on how to use the control panel

 

Mac OSx systems

  • Download the installer: Collect installer for Mac OSx systems 
  • Run the .run file as a super user and follow the instructions on the screen. Collect will be installed by default into ~/OpenForis/Collect.
  • If the installation completes successfully, you will have 2 icons in the Desktop, Launch Open Foris Collect and Update Open Foris Collect 

Start Collect

  • Double click on the Launch Open Foris Collect icon in the deskop 
  • The Collect Control Panel should appear; continue following the instruction on how to use the control panel

 

Note: Further information and technical details for the installation of Open Foris COLLECT and the difference between the installations for a single (local) user versus installing a server for a multiuser environment can be found here: http://www.openforis.org/OFwiki/index.php/Open_Foris_Collect_Installation

Using Collect Control Panel

 

  • After clicking on Launch Open Foris Collect icon, the control panel will appear
  • Please wait until the “Starting up…” message disappears and the “Running!” message appears
  • Collect will open automatically a new window in the default web browser, linking the address: http://localhost:8380/collect. This address can be different in your system: the port 8380 can be already in use in your computer, so another free port will be chosen by the installer.
  • If the Control Panel says that Collect is running but the window is not automatically opened, please open the web browser and access that address manually.
  • Collect login page should appear on the web browser; enter the system the first time using "admin" as username and "admin" as password. You can change the password later from the user interface. [If nothing happens, open a new browser window and access this url: http://localhost:8380/collect ]

Note: If an error occurs, please click on the Log button; the log details box will be opened and it will be possible to have more information about the error, or at least copy and paste the content of this text area and send it to the Open Foris Team to have support

 

Updating Collect

Open Foris Collect developers are constantly working on improving the system also taking into consideration, and trying to address, the feedback from the users in the countries. Test versions are periodically created and tested among current users while Production versions (stable) are released for public use and made available. Following are the steps for updating Collect to the newest released version.

Update using Auto Updater

Starting from version 3.2.2 Collect has an Auto Updater that you can run from the start menu

  1. close every browser window that is using Collect
  2. shutdown Collect
  3. click on "Update OF Collect" startup menu item and follow the instructions on screen
  4. startup Collect

Update from version of Collect older than 3.2.2

If you want to upgrade Collect from an older version to the new one, follow these steps:

  1. close every browser window that is using Collect
  2. shutdown Collect
  3. make a copy of the folder data (path:  c:\opt\OpenForisCollect\collect-server\tomcat\data) and store it outside of c:\opt\OpenForisCollect, e.g. in your "user" folder
  4. uninstall Collect
  5. install Collect using the new installer
  6. copy the folder data previously backed up into the folder c:\opt\openforis\collect\tomcat\
  7. start Collect and verify that all old data are present

Upgrade Collect using the war file (for expert users)

  1. Stop the Collect Tomcat instance, if running
  2. Create a backup copy of your existing Collect installation (c:\opt\OpenForisCollect folder)
  3. Create a backup of the PostgreSQL database (if you are using that as database)
  4. Download the latest war file of Collect: Collect war file
  5. Delete the folder collect-server/tomcat/webapps/collect
  6. Delete the file collect-server/tomcat/webapps/collect.war, if exists
  7. Copy the downloaded collect-web-VERSION.war file into collect-server/tomcat/webapps folder and rename it into collect.war. If you are using a unix or linux system, change collect.war owner and group to the same as tomcat user (e.g. Change the collect.war owner and group to "tomcat": sudo chown tomcat:tomcat collect.war)
  8. Start the Collect Tomcat instance

Saiku Business Analytics module (Beta) installation

From version 3.10.x Collect comes together with Saiku Business Analytics.

If you installed a previous version of Collect and you update it to the latest version, you won't be able to use the Saiku module unless you install it separately. 

You can download the latest version of the Saiku module from here:

 

Click here to return to Tutorials Main Menu