Submitting
a schema extension for NCSUNDS
Note:
This is an internal "NDSTech" document,
not intended for public consumption. As such,
it may not be complete or accurately updated.
Announce
plans to test in NCSUTEST tree to NDSTech
You
should announce your intention to test a product in
the NCSUTEST tree at least a few days before
the actual installation. This allows other groups
to coordinate with you, so that schema changes in one
product aren't accidentally recorded as part of another
product being tested.
Gather
the complete list of all schema classes, properties,
and attributes with the JRB utility "schema".
This utility is part of a campus site license, and can
be found on chaos/sitelic:JRBUtils While logged
into the NCSUTEST tree, run the command
schema
* > SchemaBefore.txt
Save
the SchemaBefore.txt file in a safe place -- you'll
need this later to determine what extensions were made.
A complete dump of the schema can take some time, and
several megabytes of disk space.
Generally,
allow at least two weeks so that other groups can detect
any collateral conflicts. In general, the campus
has been more concerned about new schema extensions
damaging or changing the behavior of existing products
in the tree than the operation of new applications,
so compatibility testing is very important!
Run
the JRB schema utility again in NCSUTEST, to
capture the state of the schema just after your product
is installed (don't wait two weeks - the sooner after
the extensions are made, the better!)
schema
* > SchemaAfter.txt
Compare
the SchemaBefore.txt and SchemaAfter.txt files and generate
a list of differences. A good tool for doing this
is CSDiff.
CSDiff
is a free text-compare utility, downloadable from http://www.componentsoftware.com/csdiff/dlcsdiff.htm
To
use, unzip into a new folder, and run CSDiff.Exe Select
Analyze "Document", choose the 2 files that
have the schema information, click the "Use older
file as a base revision" box, then click OK.
The
output will show the entire files with differences.
Changes are in green and are crossed out, and new information
is in blue and underlined.
Prepare
a list of differences, and submit it to the ndstech
list for review.
Formally
request the schema extension,
and set a proposed date
You
can request a schema extension either at a physical
meeting of the group or over e-mail. Be sure to
include the name and purpose of the software you're
installing, remind the group of the duration of the
test in the NCSUNDS tree, and state that you're
making a formal request of the group. You may
be required to perform additional testing or delay installation
to accomodate other groups' timetables.
The
schema will need to be updated by one of the [Root]
account holders (at the time this document was created,
NCS and ITD).
Install
the software in the NCSUNDS tree
After
approval, post a note to the NAG@lists.ncsu.edu
listserver (via http://sysnews.ncsu.edu)with
a general announcement to campus that the schema extension
is to be made, being sure to include the date of the
extension.
Finally,
install your software!
Schema
Extension Procedure / Last Updated October 14, 2002
|
