Liquibase

Liquibase Installation

• As of KFS 6, the impex tool has been deprecated in favor of liquibase.
• Configure the relevant properties in your local kfs-build.properties as desired.

alter system set PROCESSES=150 scope=SPFILE;

System Requirements

LiquiRelational 

LiquiRelational is a tool in the main Financials application, and can be used to load all KFS and Rice data or just incremental updates. The tool can be run automatically on application startup or from the command line. This tool reads and executes liquibase xml files from the classpath.

Running LiquiRelational

To have LiquiRelational run automatically on application startup, set the updateDatabaseOnStartup property to true, and set the other properties to the values you want (see below).

To run LiquiRelational from the command line, the updateDatabaseStartup property is not required, but the other properties should be set to the values you want. Also, the classpath needs to include the kfs-datatools classes as well as the liquibase xml to run (the easiest way to do this is to just include the classes needed to run KFS) as well as a jdbc driver. For example:

Liquibase File Locations

Base structures and data are in the following locations in the financials project:

kfs-core/src/main/resources/org/kuali/kfs/core/db/phase1 - Core Tables and Sequences

kfs-core/src/main/resources/org/kuali/kfs/core/db/phase2 - Core Data

kfs-core/src/main/resources/org/kuali/kfs/core/db/phase3 - Core Primary Keys

kfs-core/src/main/resources/org/kuali/kfs/core/db/phase4 - Core Foreign Keys, Unique Constraints, Indexes and Views

kfs-core/src/main/resources/org/kuali/kfs/core/db/phase5 - Core database updates

Financial Optional module dliquibase files are located in each module.  For example: kfs-ar/src/main/resources/org/kuali/kfs/module/ar/db/phaseX 

kfs-core/src/main/resources/org/kuali/rice/db/phase1 - Rice Tables and Sequences 

kfs-core/src/main/resources/org/kuali/rice/db/phase2 - Rice Data

kfs-core/src/main/resources/org/kuali/rice/db/phase3 - Rice Primary Keys

kfs-core/src/main/resources/org/kuali/rice/db/phase4 - Rice Foreign Keys, Unique Constraints, Indexes and Views

kfs-core/src/main/resources/org/kuali/rice/db/phase5 - Rice database updates

LiquiRelational Properties

The following properties control how LiquiRelational operates:

Since LiquiRelational needs a database to operate on, the following properties are also used to build a DataSource. Most of these properties are also described in Configuration Properties.

Workflow Ingestion

Ingest Workflow XML

• Workflow xml is located in the following folders in the financials project:

  • kfs-core/src/main/resources/org/kuali/kfs/sys/workflow/parent

  • kfs-core/src/main/resources/org/kuali/kfs/sys/workflow/child

  • kfs-ar/src/main/resources/org/kuali/kfs/module/ar/workflow

  • kfs-cam/src/main/resources/org/kuali/kfs/module/cam/workflow

  • kfs-cg/src/main/resources/org/kuali/kfs/module/cg/workflow

  • kfs-ec/src/main/resources/org/kuali/kfs/module/ec/workflow

  • kfs-kc/src/main/resources/org/kuali/kfs/module/external/kc/workflow

  • kfs-ld/src/main/resources/org/kuali/kfs/module/ld/workflow

  • kfs-purap/src/main/resources/org/kuali/kfs/module/purap/workflow

• Workflow xml can be ingested through the KFS Application by one of the following methods:
  • Archive the files in the above folders as a zip file.  Log into KFS as a user able to ingest workflow document types and go to the XML Ingester screen (with foundation data, backdoor in as user "admin" and go to the Admin tab, configuration channel, under "Workflow").  Choose the zip file you've created, and press the "upload xml data" button.
  • Alternatively, you can upload each of the XML files within the the above folders src/main/config/workflow individually.  If you choose this course of action, you should load them in the order above.

  • As a third option, you can turn on the XmlPollerService.  The XmlPollerService starts when KFS is started, and as long as the properties it depends upon on present, it will sit in the background and attempt to ingest any xml files put into the directory it listens to.  What are those properties?

    Property Name	Description
    xml.pipeline.lifecycle.enabled	If set to "true", then the XmlPollerService will start to poll the data.xml.root.location for incoming XML files to ingest.
    data.xml.root.location	The directory which the XmlPollerService should check to find new workflow documents.
    data.xml.pending.location	The directory where XmlPollerService will place XML files which it finds, before it has a chance to process them.
    data.xml.completed.location	The directory where XmlPollerService places XML files which were successfully ingested.
    data.xml.problem.location	The directory where XmlPollerService places XML files which could not be successfully ingested.
    data.xml.pollIntervalSecs	The number of seconds XmlPollerService will wait before checking data.xml.root.location for new XML files to ingest.
    initialDelaySecs	The number of seconds XmlPollerService should wait before it starts processing files in the data.xml.root.location directory.  Setting this to some amount of time - say, 30 seconds - is likely a good idea, as it will give KFS time to fully start before polling begins.

    Just add these to your runtime properties file, and any files added to data.xml.root.location will be ingested automatically.

  • In order to automatically ingest workflow xml on application startup, set the updateWorkflowOnStartup property to true and populate the workflow.path property with the workflow xml you wish to have ingested. This property can be set to a comma-separated list of files or locations. It can contain files or paths to read from the classpath ( prefix with classpath: ) or the filesystem ( prefix with file: ) and paths can contain wildcards. The files or paths should end in .xml.

For example:

To ingest all workflow xml (except KC):

workflow.path=classpath:org/kuali/kfs/sys/workflow/parent/*.xml,\
  classpath:org/kuali/kfs/sys/workflow/child/*.xml,\
  classpath:org/kuali/kfs/module/ar/workflow/*.xml,\
  classpath:org/kuali/kfs/module/cam/workflow/*.xml,\
  classpath:org/kuali/kfs/module/cg/workflow/*.xml,\
  classpath:org/kuali/kfs/module/ec/workflow/*.xml,\
  classpath:org/kuali/kfs/module/ld/workflow/*.xml,\
  classpath:org/kuali/kfs/module/purap/workflow/*.xml



kew.mode=LOCAL
dev.mode=true

• • Workflow ingestion can also be done via the command line by running the org.kuali.kfs.sys.context.WorkflowImporter class. The classpath needs to include the classes needed to run KFS.

For example:

java -classpath /Users/user/IdeaProjects/financials/kfs-web/target/kfs-web/WEB-INF/lib/*:/Users/user/java/servers/apache-tomcat-7.0.59/lib/* -Dadditional.kfs.config.locations=/Users/user/kfs-override-config.properties org.kuali.kfs.sys.context.WorkflowImporter