Overview

This inten­tion of this doc­u­ment is to explain steps that have been tak­en at Visu­al Soft­ware to pro­vide facil­i­ties for a Web Ser­vices-based deliv­ery of core parts of the Schools Inter­op­er­abil­i­ty Frame­work spec­i­fi­ca­tions for the US, UK and Aus­tralia.

The orig­i­nal pur­pose of this web ser­vice was to meet inter­nal VSI needs that would allow our prod­ucts to auto­mat­i­cal­ly update them­selves from a cen­tral repos­i­to­ry, allow­ing us to deploy new ver­sions, changes and cor­rec­tions in a more time­ly and con­sis­tent man­ner. After hear­ing that the SIF com­mu­ni­ty was also look­ing for some­thing sim­i­lar, we made the offer to make this ser­vice pub­licly avail­able for con­sump­tion by those who would ben­e­fit, at least for the short term.

Technical Overview

At its core are four tables that main­tain four types of spec­i­fi­ca­tion infor­ma­tion:

• sifOb­jects - this describes each dif­fer­ent spec­i­fi­ca­tion of each object that is part of the data mod­el and pro­vides descrip­tive infor­ma­tion that has been pub­lished in the offi­cial doc­u­men­ta­tion
• sifEn­ti­ties - these are the attrib­ut­es and objects. The infor­ma­tion stored includes every­thing that is includ­ed in the spec­i­fi­ca­tion as well as the entity's rela­tion­ship with any con­tain­er in which it may belong
• sif­Code­Val­ues - this table main­tains infor­ma­tion about every code val­ue for every spec­i­fi­ca­tion, the map­pings, and the descrip­tions.
• sifEx­tend­edEle­ments - this is a reg­istry of Extend­ed Ele­ments. If an orga­ni­za­tion want­ed to add an extend­ed ele­ment, it would not add a new enti­ty, but would define a new Extend­ed Ele­ment name val­ue. This table would keep track of who defined them and what they are used for.

Database Definitions

The web ser­vice pub­lish­es data from the four above tables. These tables are defined as fol­lows:

sifObjects

(this table still needs doc­u­men­ta­tion and edit­ing)

	Name	Data Type	Max Length (Bytes)	Allow Nulls	Iden­ti­ty	Default
[[Image:]]	Record­ID	int	4	û	1‑Jan
[[Image:]]	Country­Code	varchar(10)	10	ü
	Data­Model­Version	varchar(10)	10	ü
[[Image:]]	Infrastructure­Version	varchar(10)	10	ü
	Locality­Name	varchar(50)	50	ü
	Object­Name	varchar(175)	175	ü
[[Image:]]	Working­Group	varchar(175)	175	ü
	Events­Reported	bit	1	û		((1))
	Descrip­tion	varchar(max)	max	ü
	Date­Created	date­time	8	ü		(get­date())
	Last­Updated	date­time	8	ü
	Is­Deprecated	bit	1	û		((0))
	Is­Deleted	bit	1	û		((0))
	Created­By	varchar(255)	255	ü
	Maintained­By	varchar(255)	255	ü

sifEntities

(this table still needs edit­ing)

	Name	Data Type	Max Length (Bytes)	Allow Nulls	Iden­ti­ty	Default
[[Image:]]	Record­ID	int	4	û	1‑Jan
	Record Unique Iden­ti­fi­er
	Country­Code	varchar(10)	10	ü
	Data Mod­el Coun­try — US, UK, AU or GLOBAL
	Data­Model­Version	varchar(10)	10	ü
	Data Mod­el Ver­sion
	Infrastructure­Version	varchar(10)	10	ü
	Infra­struc­ture that sup­ports this data mod­el for this coun­try (use­ful for queries)
	Locality­Name	varchar(50)	50	ü
	(this should not be used)
	Object­Name	varchar(175)	175	ü
	SIF object relat­ed to the element/attribute
	XML_­Sequence	small­int	2	ü
	This is used for order­ing the enti­ties
	Item­Type	varchar(10)	10	ü		((0))
	E=Element, A=Attribute, GS=Group Start, GE=Group End, RCS=Repeating Con­tain­er Start, RCE=Repeating Con­tain­er End, RES=Repeating Ele­ment Start, REE=Repeating Ele­ment End
	Item­Name	varchar(175)	175	ü
	Ele­ment, Attribute or Group Name
	XPATH	varchar(400)	400	ü
	The XPATH (not includ­ing the base object name itself)
	Char­ac­ter­is­tic	varchar(10)	10	ü
	M=Mandatory, O=Optional, C=Conditional, MR=Mandatory Repeat­able
	Descrip­tion	varchar(max)	max	ü
	The descrip­tion of the enti­ty as found in the orig­i­nal SIF spec­i­fi­ca­tion
	Date­Created	date­time	8	ü		(get­date())
	Date this entry was first cre­at­ed
	Last­Updated	date­time	8	ü
	Date this entry was last edit­ed
	Is­Deprecated	bit	1	ü		((0))
	This code val­ue will be removed in a future release of the SIF spec­i­fi­ca­tion
	Is­Deleted	bit	1	ü		((0))
	This code val­ue has been log­i­cal­ly delet­ed from the code val­ues col­lec­tion — DO NOT USE THIS VALUE
	Created­By	varchar(255)	255	ü
	Name of the account that cre­at­ed this code val­ue table entry
	Maintained­By	varchar(255)	255	ü
	Name of the account that last mod­i­fied this code val­ue table entry

sifCodeValues

	Name	Data Type	Max Length (Bytes)	Allow Nulls	Iden­ti­ty	Default
[[Image:]]	Record­ID (Record Unique Iden­ti­fi­er)	int	4	û	1‑Jan
	Country­Code (Data Mod­el Coun­try — US, UK, AU or GLOBAL)	varchar(10)	10	ü
	Data­Model­Version	varchar(10)	10	ü
	Infrastructure­Version [Infra­struc­ture that sup­ports this data mod­el for this coun­try (use­ful for queries)]	varchar(10)	10	ü
	Locality­Name (this should not be used)	varchar(50)	50	ü
	Object­Name (SIF object relat­ed to the element/attribute)	varchar(175)	175	ü
	XML_­Sequence (This is used for order­ing the enti­ties)	small­int	2	ü
	Item­Type (E=Element, A=Attribute, GS=Group Start, GE=Group End, RCS=Repeating Con­tain­er Start, RCE=Repeating Con­tain­er End, RES=Repeating Ele­ment Start, REE=Repeating Ele­ment End)	varchar(10)	10	ü		((0))
	Item­Name (Ele­ment, Attribute or Group Name)	varchar(175)	175	ü
	XPATH (not includ­ing the base object name itself)	varchar(400)	400	ü
	Char­ac­ter­is­tic (M=Mandatory, O=Optional, C=Conditional, MR=Mandatory Repeat­able)	varchar(10)	10	ü
	Descrip­tion (The descrip­tion of the enti­ty as found in the orig­i­nal SIF spec­i­fi­ca­tion)	varchar(max)	max	ü
	Date­Created (Date this entry was first cre­at­ed)	date­time	8	ü		(get­date())
	Last­Updated (Date this entry was last edit­ed)	date­time	8	ü
	Is­Deprecated (This code val­ue will be removed in a future release of the SIF spec­i­fi­ca­tion)	bit	1	ü		((0))
	Is­Deleted (This code val­ue has been log­i­cal­ly delet­ed from the code val­ues col­lec­tion — DO NOT USE THIS VALUE)	bit	1	ü		((0))
	Created­By (Name of the account that cre­at­ed this code val­ue table entry)	varchar(255)	255	ü
	Maintained­By (Name of the account that last mod­i­fied this code val­ue table entry)	varchar(255)	255	ü

sifExtendedElements

(this still needs doc­u­men­ta­tion and edit­ing)

	Name	Data Type	Max Length (Bytes)	Allow Nulls	Iden­ti­ty	Default
	Record­ID	int	4	no	1–1
	Country­Code	varchar(10)	10	yes
	Data­Model­Version	varchar(10)	10	yes
	Infrastructure­Version	varchar(10)	10	yes
	Locality­Name	varchar(50)	50	yes
	Object­Name	varchar(175)	175	yes
	Extended­Element­Name	varchar(255)	255	yes
	Extended­Element­Type	varchar(max)	max	yes
	Descrip­tion	varchar(max)	max	yes
	Date­Created	date­time	8	yes		(get­date())
	Last­Updated	date­time	8	yes		(get­date())
	Is­Deprecated	bit	1	yes		((0))
	Is­Deleted	bit	1	yes		((0))
	Created­By	varchar(255)	255	yes		('admin')
	Maintained­By	varchar(255)	255	yes

The SIFSpecService.svc Web Service

The SIFSpecService.svc web ser­vice is avail­able to appli­ca­tions to query this data­base and will be avail­able in the future for updat­ing it as well. This web ser­vice expos­es an ODa­ta inter­face which allows it to be access­able by many off-the-shelf libraries, devel­op­ment envi­ron­ments and exist­ing appli­caitons as if it were a local data­base con­nec­tion.