| Note | ||
|---|---|---|
| ||
This document describes the mechanics of the database version control process. How the changes get into the master schema must still be decided by the OLE development team. |
| Table of Contents |
|---|
Process Overview
To manage and track database changes, the Kuali OLE project utilizes Subversion to track the master state of the database at any given point in time. The ole-cfg-dbs project in the Subversion repository is considered the definitive source and is stored as a combination of XML (for database structure) and flat files (for data.)
...
The additional complication to this is that there are actually three components to the full refresh process as will be discussed below.
Rice Data Overview
Since OLE is one of a number of Kuali Rice-based projects, an installation of it also includes certain Rice tables and their associated data. However, storing this data in our master schema leads to maintenance issues when the master structure changes and potential data collisions with other Kuali projects. As such, we rely on the "master" rice datasource directly.
The database impex tool (https://test.kuali.org/svn/kul-cfg-dbs/branches/clover-integration) allows for two database definitions to be overlaid upon one another. So, for a simple install of OLE, where the Rice server is integrated into the application, the impex tool first imports the Rice tables and data into the OLE database and then adds the OLE tables and data.
This, however, does not then include any of the OLE-specific data which needs to be stored in the Rice tables. This includes items such as:
- Workflow Documents (KEW)
- System Parameters (KNS)
- Test Users (KIM)
- Application-Specific Roles (KIM)
- Permissions (KIM)
- Responsibilities (KIM)
To import those, we have two additional steps. (This will hopefully be a single step in the future, when Rice provides for XML import/export for all of these objects.)
- Run Liquibase scripts to add the KNS and KIM data.
- Run the workflow XML Ingester tool (part of Rice) to add the workflow definitions.
The definitions for these items are stored in the following locations:
ole/work/db/rice-data(KIM/KNS)ole/work/workflow(KEW)
After all "normal" import processes are done, these scripts/files are executed/imported as a final step to load the OLE data into the database.
...
OLE Rice Data Maintenance
ole-cfg-dbs Project Structure
Directory | Description |
|---|---|
| The database import/export tool used to process the contents of the directory below. Loaded automatically from the Kuali SVN repository. |
| The OLE database description - see below. |
| The matching Rice database description - loaded from the rice project. |
...
Also, the ole-cfg-dbs project directory contains an svn:externals property which pulls in the correct version of Rice for OLE. (See the subversion documentation for more information.) This causes SVN to pull the needed definitions directly from the Rice project.
Rice Data Locations and Structure
The Rice data needed by OLE is stored within the main ole project in the locations below:
Directory | Description |
|---|---|
| Rice KNS and KIM data. (Parameters, Roles, Permissions, etc...) |
| OLE workflow document definitions. |
The non-workflow Rice data scripts use Liquibase for inserting the data into the Rice tables. Most of them (for practical reasons), simply load a CSV file with the OLE data into the needed tables. Review the Liquibase XML files in the ole/work/db/rice-data for the details. They are split up into two sets, demo and bootstrap. Under normal operation, both are executed. Usually, the demo scripts add data not in the bootstrap scripts but in at least one case (system parameters), it overlays the entire set of OLE parameters.
OLEDBA Master Schema
All changes to the base OLE database structure and baseline demonstration data must be done within this schema. The schema is located at:
...
Changes made there will be exported into the ole-cfg-dbs SVN project nightly and used to refresh the OLELOCAL, OLEDEV, and OLECI databases. (as well as any developer satellite instances the next time they run the process)
Demo vs. Bootstrap Datasets
All of the Kuali projects have the concept of a development dataset (hence the ole-cfg-dbs/development path), a demo dataset, and a bootstrap dataset. In most cases, the development and demo datasets are the same. The main difference between these is the removal of Kuali environment-specific URLs or email addresses.
...