Page History

1. On the cTAKES downloads page, download the User Installation package.

2. (Recommended) Verify the downloaded files against a signature to ensure you have the proper and complete file.

From the following directory, download the signature file that corresponds to your download from step 1

https://www.apache.org/dist/ctakes/ctakes-4.0.0/ 

Please do not download any of the files that end with .zip or .gz directly from apache.org/dist - using the downloads page listed in step 1 for cTAKES install packages will take advantage of using a mirror.

No example

3. Unzip the file you downloaded into a directory that you want to be the cTAKES install location. The compressed files contain a single directory at the top level. This folder we will call <cTAKES_HOME>. It is the directory that contains subdirectories like bin, desc, resources, and lib.

You will need to refer to this directory later.

Windows:

C:\apache-ctakes-4.0.0

Linux:

/usr/local/apache-ctakes-4.0.0

Windows:

Linux:

tar -xvf apache-ctakes-4.0.0.bin.tar.gz -C /usr/local

4. Download the cTAKES resources ZIP file with a matching version from the ctakesresources project (More information on cTAKES models). These resources are required to operate cTAKES.

Unzip the cTAKES resources file into a temporary location.

Windows:


Linux:

 
cd /tmp
 
wget http://sourceforge.net/projects/ctakesresources/files/ctakes-resources-4.0-bin.zip
 
sudo unzip ctakes-resources-4.0-bin.zip
 
 

5. Copy (or move) the resources to cTAKES_HOME.
Copy the contents of the temporary resources directory (and all sub-directories) to <cTAKES_HOME>/resources.

Windows:

xcopy /s C:\temp\ctakes-resources-4.0-bin\resources C:\apache-ctakes-4.0.0\resources

Linux:

cp -R /tmp/resources/* /usr/local/apache-ctakes-4.0.0/resources

Mac OSX:

ditto /tmp/resources/* /usr/local/apache-ctakes-4.0.0/resources

1. If you created your own HSQLDB dictionaries for use with a previous release of cTAKES and you plan to use those dictionaries with cTAKES 4.0, you must convert your dictionaries to be compatible with cTAKES 4.0. The dictionaries installed in the preceding section do not need to be converted.

• Suggested: make a copy of your database directory for use with 4.0, so that the filename.properties and filename.script and any other files in that directory are duplicated, where filename is dependent on what you named your database
• Locate the filename.properties file for your database
• Remove these lines, if present:

    readonly=truetrue  
  files_readonly=true

• Save the filename.properties file

3.  Open the database with the 1.8 hsqldb jar:

Locate the 1.8 hsqldb jar that you used when you created the database (for example, <CTAKES_HOME>. For example, if you used the cTAKES 3.2.2 convenience binary, <cTAKES_HOME_FOR_3.2.2>/lib/hsqldb-1.8.0.10.jar if you used the cTAKES 3.2.2 convenience binaryjar )

If you need to, you can download it from Maven Central at:

http://central.maven.org/maven2/org/hsqldb/hsqldb/1.8.0.10/hsqldb-1.8.0.10.jar

Open the HSQLDB manager GUI for version 1.8. For example, if your 1.8 jar is in C:\Apps\hsqldb\, you would enter this command:

java -cp  C:\Apps\hsqldb\hsqldb-1.8.0.10.jar   org.hsqldb.util.DatabaseManager

Connect to your database, by entering the appropriate URL and pressing the Ok button.

For example, if you are on Windows and your dictionary's.properties file is

C:\cTAKES_3\resources\org\apache\ctakes\dictionary\lookup\fast\customdict\custom.properties

you could enter the following for the URL

jdbc:hsqldb:\cTAKES_3\resources\org\apache\ctakes\dictionary\lookup\fast\customdict\custom

4.  Using HSQLDB 1.8, in the upper right pane, enter SET SCRIPTFORMAT TEXT and press the Execute button.

After the update count appears, go to the next step.

5. Using HSQLDB 1.8, in the upper right pane, enter SHUTDOWN COMPACT and press the Execute button.

After the update count appears, exit the Database Manager GUI.

6. Now do the same with hsqldb 2.3.4 jar - open the HSQLDB 2.3.4 database manager GUI:

java  -cp C:\apache-ctakes-4.0.0\lib\hsqldb-2.3.4.jar   org.hsqldb.util.DatabaseManager

Connect to your database, by entering the appropriate URL and pressing the Ok button.

In the upper right pane, enter SHUTDOWN COMPACT and press the Execute button.

Exit After the update count appears, exit the Database Manager GUI.

7. Verify the filename.properties file for your database contains version=2.3.4

If it doesn't, make sure

   the  .properties  file does not have  readonly=true

   the  .properties  file does not have  files_readonly=true

   you used hsqldb-2.3.4.jar when instructed to

8. Suggested: Set your dictionary's database to be read-only, by adding readonly=true to the filename.properties file.