Quickstart Setup

T

Use the following installation instructions to guide you through the baseline out-of-the-box setup.

link.png

Information on more advanced configuration and customization can be found in the public documentation.

caution.png Before You Begin - The following are required:

      Java 1.5

      Servlet 2.4 / JSP 2.0 Compatible Servlet Container such as Apache Tomcat 5.5

      Oracle database instance or MySQL database instance

     

To set up KC (and Rice) database:

 

KC database release contains all SQL scripts needed to install a new schema or upgrade a KC 3.0 or 3.0.1 database using Rice bundled or embedded mode with the database objects (tables, constraints, bootstrap data) for the KC application.

 

If installing in an embedded Rice environment you will be prompted to install/upgrade Rice.  If your Rice server has been upgraded already you will answer no to the question (KC-specific data will still be added to your Rice server).

 

 

Installation Steps for Oracle

note.png  Installation has been tested with sqlplus and SQL Developer.  Other tools may require modification of the scripts.

1.

Create Oracle username of less than 8 characters

2.

Make sure Oracle user has following privileges:

 

* DEFAULT TABLESPACE set to <Users Tablespace> (the intended location where the schema database structures and base bootstrap data are stored).

* QUOTA UNLIMITED ON <Users Tablespace>

* CREATE SESSION

* CREATE SYNONYM

* CREATE PROCEDURE 

* CREATE TRIGGER

* CREATE TABLE 

* CREATE TYPE 

* CREATE VIEW

* CREATE SEQUENCE

note.png  A user’s DEFAULT TABLESPACE is set with the CREATE USER statement or ALTER USER statement. The TABLESPACE should not be the SYSTEM tablespace.

caution.png  A New install will COMPLETELY clear data from any existing KC tables in this schema!

 

 

Installation Steps for MySQL

note.png  Installation has been tested with mysql client.  Other tools may require modification of the scripts.

1.

Set the following settings in MySQL:

max_allowed_packet=1M

transaction-isolation=READ-COMMITTED

lower_case_table_names=1

max_connections=1000

2.

Create MySQL username of less than 8 characters.

3.

Create MySQL default schema for username with the default character set of UTF8.  If a different character set is desired, the ddl scripts will need to be updated to the new character set.

4.

Make sure MySQL user has following privileges on the schema

          * Select

          * Insert

          * Update

          * Delete

          * Create 

          * Drop

          * Index

          * Alter

          * Create_view

          * Create_routine

          * Alter_routine

          * Create_tmp_table

          * Lock_tables

 

caution.png  Be sure the schema is empty before  a NEW installation.

 

 End of activity.

 

 

To populate data into KC (and Rice) database:

 

 

Installation Steps for Both Oracle and MySQL

 

1.

Run the appropriate install script in db_scripts/main (KC_Install.bat for Windows or KC_Install.sh for Linux/Unix).

2.

You will be prompted for the following:

   - Rice Mode = Choose one: Bundle, Embed

   - DB_Server = Choose one: Oracle, MySQL

   - Version = Choose one: New, 3.0, 3.0.1, 3.1, 4.0

   - username = The KC database username name to install database scripts with (bundled Rice goes here too).

   - password = the password for username

   - DB_server_name = the tns name (Oracle) or schema name (MySQL) used to connect to KC database.

   If embedded mode selected the following will be asked:

   - Rice Username = the Rice database username to install rice scripts with (embedded Rice).

   - Rice Password = password for Rice username

   - Rice DB Server name = the tns/schema name used to connect to Rice database.

   - Do you wish to Install/Upgrade your Embedded Rice Server (Don't perform if your server was upgraded separately)

 

3.

Review .log files for installation errors (in LOGS directory).

4.

(Optional) Install demonstration data. Convenience install scripts for demonstration data can be found in the db_scripts/main folder (KC_Install_Demo.sh/bat) . The demonstration data is only guaranteed to install cleanly into a new KC install.  If you have previous test data or demonstration data then you will encounter errors, which may or may not affect functionality.

caution.png  Demonstration data is for testing functionality of the software only and should not be included in an actual implementation.  Take a backup of your database before applying demonstration data or be prepared to reinstall from scratch before implementation.

 

 End of activity.

 

tip.png

Tip:  Refer to “”Appendix A:  Configuration Parameters” on page Error! Bookmark not defined.” within this documentation set for supplementary information that will prove helpful by providing default values and handy tips for both KC-specific and Rice parameters.