Versions Compared

Version Old Version 1 New Version 2
Changes made by

Jonathan Keller

Jonathan Keller

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Also see System Requirements 3 for database setupsome additional database parameters which should be considered, especially for MySQL.

Impex Tool Installation

Note

The projects listed below are for documentation only. As part of checking out the main ole project, Subversion will automatically check out both the ole-cfg-dbs project and the kul-cfg-dbs projects.

  • Check out needed projects from SVN. They should all be checked out into the same base directory with the name given in the first column. (/java/projects if using the standard paths)

    Project Name

    SVN URL

     

    kul-cfg-dbs

    		https://test.kuali.org/svn/kul-cfg-dbs/branches/clover-integration

    Database import/export tool

    kfsole-cfg-dbs

    		https://testsvn.kuali.org/svnrepos/kfsole-cfg-dbs/branches/release-4-0-1 KFS trunk

    ole base dataset

    kfs ole

    		https://testsvn.kuali.org/svnrepos/kfs/branches/release-4-0-1 KFS ole/trunk

    OLE project for workflow and Rice data

  • Copy the kul-cfg-dbsone of the ole/impex/impex-build-local-sample*.properties to your home directory as impex-build.properties
  • Configure the import.* properties in that file for your local database.

...

Property Name

Default

Description

File Locations

 

 

torque.schema.dir

../../kfs-cfg-dbs/rice

Specifies the directory which contains all the XML files describing the Rice database tables.

torque.schema.dir.2

../../kfs-cfg-dbs/development

Specifies the directory which contains all the XML files describing the KFS ole database tables.

KFS ole Rice Data Overlay

 

 

post.import.liquibase.project

kfs ole

Should be the name of the application project. It just needs to be set to activate the process.

post.import.liquibase.xml.directory

../../${post.import.liquibase.project}/work/db/rice-data

Directory containing liquibase scripts to execute.

KFS ole Workflow Data

 

 

post.import.workflow.project

Should be the name of the application project. It is used to activate the process and in other default directory locations.

post.import.workflow.xml.directory

../../${post.import.workflow.project}/work/workflow

Directory from which to read workflow XML files.

post.import.workflow.ingester.additional.command.line

No Format
-Ddatasource.ojb.platform=Oracle9i
-Dbase.directory=/java
-Dis.local.build=
-Ddev.mode=true
-Drice.ksb.batch.mode=true
-Ddont.filter.project.rice=
-Ddont.filter.project.spring.ide=
-Dappserver.lib.dir=${basedir}/../../kfs/build/tomcat/common/lib
-Dappserver.classes.dir=${basedir}/../../kfs/build/tomcat/common/classes

Extra parameters needed to make the KFS ole build work. The ingester process needs to bring up the server for a few minutes. Make sure you change that first property to "MySQL" if that is your database platform.

Import Destination

 

 

import.torque.database

oracle

The type of database you will be importing into. Valid values are oracle and mysql.

import.torque.database.driver

oracle.jdbc.OracleDriver

The fully-qualified class name of your JDBC driver.

import.torque.database.url

jdbc:oracle:thin:@localhost:1521:XE
jdbc:mysql://localhost:3306/kfsdev oledev

The JDBC URL for your database.

import.torque.database.user

kfsdev oledev

The user to use when importing the tables into the database.

import.torque.database.password

kfsdev oledev

Password for the above account.

import.torque.database.schema

KFSDEV OLEDEV

The name of the schema to import the objects into. MUST be the same as the user. For Oracle, the schema name must be in upper case. In MySQL, you probably want this to be in lower case.

Administrative Properties

 

 

import.admin.user

kuluser_admin

Account which will be used to create and destroy users and schemas. On Oracle, this account must have execute privilege on the KULUSER_MAINT_PK package owned by the account specified in the oracle.usermaint.user property. For MySQL, this must be an account with administrative privileges (such as root).

import.admin.password

kuluser_admin

Password for the above account.

import.admin.url

jdbc:oracle:thin:@localhost:1521:XE
jdbc:mysql://localhost:3306

The JDBC URL used to connect to the database for administrative purposes (creating / recreating users). This will default to the import URL, but must be changed for MySQL databases, as it will fail to connect if the schema at the end of the URL does not exist. The MySQL URL shown here has no default database specified.

oracle.usermaint.user

kulusermaint

Only used for Oracle imports. Account which contains the KULUSER_MAINT_PK package and has permissions to create and drop users and kill sessions.

oracle.usermaint.password

kulusermaint

Password for the above account. Only needed here to run the bootstrap target. (See instructions below.)

...

  • Configure the import.admin.user and import.admin.password properties appropriately.
  • Important: Configure import.admin.url to not include the target schema. (I.e., remove the "/kfsdevoledev" from the end.) Failure to do this will cause the schema/user setup commands to abort.

...

  • Initial Setup
    • Perform the above steps to set up the database and create the user.
  • Daily Run
    • In the early AM, run the import process. (The daily export runs from 2 - 3 am. (EST))
      • cd to /java/projects (or your equivalent)
      • perform a SVN update via a shell script to ensure you have the most recent version of the tool and all projects:
        • svn update kfs kul-cfg-dbs kfs-cfg-dbs rice-cfg-dbsole
      • cd to kulole/ole-cfg-dbs/db-impex/impex
      • Run the impex tool:
        Code Block
        ant empty-schema import
        Note

        This target will completely empty the schema referenced in the impex-build.properties file, and then run the import.