ICAT Schema

Application, Datafile, DatafileFormat, DatafileParameter, Dataset, DatasetParameter, DatasetType, Facility, FacilityCycle, Group, InputDatafile, InputDataset, Instrument, InstrumentScientist, Investigation, InvestigationParameter, InvestigationType, InvestigationUser, Job, Keyword, NotificationRequest, OutputDatafile, OutputDataset, ParameterType, PermissibleStringValue, Publication, RelatedDatafile, Rule, Sample, SampleParameter, SampleType, Shift, Study, StudyInvestigation, User, UserGroup

Application

Some piece of software

Uniqueness constraint name, version

Relationships

Card	Class	Field	Cascaded	Description
0,*	Job	jobs	Yes

Other fields

Field	Type	Description
name	String [255]	A short name for the software - e.g. mantid
version	String [255]

Datafile

A data file

Uniqueness constraint name, location, dataset

Relationships

Card	Class	Field	Cascaded	Description
0,1	DatafileFormat	datafileFormat
0,*	RelatedDatafile	sourceDatafiles	Yes
0,1	Dataset	dataset		The dataset which holds this file
0,*	DatafileParameter	parameters	Yes
0,*	OutputDatafile	outputDatafiles	Yes
0,*	RelatedDatafile	destDatafiles	Yes
0,*	InputDatafile	inputDatafiles	Yes

Other fields

Field	Type	Description
name	String [255] NOT NULL	A name given to the file
description	String [255]	A full description of the file contents
fileSize	Long	Expressed in bytes
doi	String [255]	The Digital Object Identifier associated with this data file
datafileCreateTime	Date	Date of creation of the actual file rather than storing the metadata
location	String [255]	The logical location of the file - which may also be the physical location
checksum	String [255]	Checksum of file represented as a string
datafileModTime	Date	Date of modification of the actual file rather than of the metadata

DatafileFormat

A data file format

Uniqueness constraint facility, name, version

Relationships

Card	Class	Field	Cascaded	Description
1,1	Facility	facility		The facility which has defined this format
0,*	Datafile	datafiles	Yes	Files with this format

Other fields

Field	Type	Description
description	String [255]	An informal description of the format
name	String [255] NOT NULL	A short name identifying the format -e.g. "mp3" within the facility
version	String [255]	The version if needed. The version code may be part of the basic name
type	String [255]	Holds the underlying format - such as binary or text

DatafileParameter

A parameter associated with a data file

Uniqueness constraint datafile, type

Relationships

Card	Class	Field	Cascaded	Description
1,1	ParameterType	type		The type of the parameter
1,1	Datafile	datafile		The associated data file

Other fields

Field	Type	Description
numericValue	Double	The value if the parameter is numeric
dateTimeValue	Date	The value if the parameter is a date
stringValue	String [4000]	The value if the parameter is a string
rangeTop	Double	The maximum value of the numeric parameter that was observed during the measurement period
rangeBottom	Double	The minimum value of the numeric parameter that was observed during the measurement period
error	Double	The error of the numeric parameter

Dataset

A collection of data files and part of an investigation

Uniqueness constraint sample, investigation, name, type

Relationships

Card	Class	Field	Cascaded	Description
0,1	Sample	sample
0,1	Investigation	investigation
0,*	Datafile	datafiles	Yes	The data files within the dataset
1,1	DatasetType	type
0,*	DatasetParameter	parameters	Yes
0,*	OutputDataset	outputDatasets	Yes
0,*	InputDataset	inputDatasets	Yes

Other fields

Field	Type	Description
complete	boolean	May be set to true when all data files and parameters have been added to the data set. The precise meaning is facility dependent.
description	String [255]	An informal description of the data set
name	String [255] NOT NULL	A short name for the data set
doi	String [255]	The Digital Object Identifier associated with this data set
startDate	Date
location	String [255]	Identifies a location from which all the files of the data set might be accessed. It might be a directory
endDate	Date

DatasetParameter

A parameter associated with a data set

Uniqueness constraint dataset, type

Relationships

Card	Class	Field	Cascaded	Description
1,1	ParameterType	type		The type of the parameter
1,1	Dataset	dataset		The associated data set

Other fields

Field	Type	Description
numericValue	Double	The value if the parameter is numeric
dateTimeValue	Date	The value if the parameter is a date
stringValue	String [4000]	The value if the parameter is a string
rangeTop	Double	The maximum value of the numeric parameter that was observed during the measurement period
rangeBottom	Double	The minimum value of the numeric parameter that was observed during the measurement period
error	Double	The error of the numeric parameter

DatasetType

A type of data set

Uniqueness constraint facility, name

Relationships

Card	Class	Field	Cascaded	Description
0,*	Dataset	datasets	Yes
1,1	Facility	facility		The facility which has defined this data set type

Other fields

Field	Type	Description
name	String [255] NOT NULL	A short name identifying this data set type within the facility
description	String [255]	A description of this data set type

Facility

An experimental facility

Uniqueness constraint name

Relationships

Card	Class	Field	Cascaded
0,*	InvestigationType	investigationTypes	Yes
0,*	FacilityCycle	facilityCycles	Yes
0,*	Investigation	investigations	Yes
0,*	DatasetType	datasetTypes	Yes
0,*	SampleType	sampleTypes	Yes
0,*	Instrument	instruments	Yes
0,*	DatafileFormat	datafileFormats	Yes
0,*	ParameterType	parameterTypes	Yes

Other fields

Field	Type	Description
daysUntilRelease	Integer	The number of days before data is made freely available after collecting it.
fullName	String [255]	The full name of the facility
description	String [1023]	A description of this facility
name	String [255] NOT NULL	A short name identifying this facility
url	String [255]	A URL associated with this facility

FacilityCycle

An operating cycle within a facility

Uniqueness constraint facility, name

Relationships

Card	Class	Field	Cascaded	Description
1,1	Facility	facility		The facility which has this cycle
0,*	Investigation	investigations	Yes

Other fields

Field	Type	Description
endDate	Date	End of cycle
startDate	Date	Start of cycle
name	String [255] NOT NULL	A short name identifying this facility cycle within the facility
description	String [255]	A description of this facility cycle

Group

A group of users

Uniqueness constraint name

Relationships

Card	Class	Field	Cascaded	Description
0,*	UserGroup	userGroups	Yes
0,*	Rule	rules	Yes

Other fields

Field	Type	Description
name	String [255] NOT NULL	A short name identifying this group of users

InputDatafile

Many to many relationship between data file as input and a job

Relationships

Card	Class	Field	Cascaded	Description
1,1	Datafile	datafile
1,1	Job	job

InputDataset

Many to many relationship between data set as input and a job

Relationships

Card	Class	Field	Cascaded	Description
1,1	Job	job
1,1	Dataset	dataset

Instrument

Used by a user within an investigation

Uniqueness constraint facility, name

Relationships

Card	Class	Field	Cascaded	Description
0,*	Investigation	investigations	Yes
0,*	InstrumentScientist	instrumentScientists	Yes
1,1	Facility	facility		The facility which has this instrument

Other fields

Field	Type	Description
name	String [255] NOT NULL	A short name identifying this instrument within the facility
description	String [4000]	A description of this instrument
fullName	String [255]	The formal name of this instrument
type	String [255]

InstrumentScientist

Relationship between an ICAT user as an instrument scientist and the instrument

Uniqueness constraint user, instrument

Relationships

Card	Class	Field	Cascaded	Description
1,1	User	user
1,1	Instrument	instrument

Investigation

An investigation or experiment

Uniqueness constraint name, visitId, facilityCycle, instrument

Relationships

Card	Class	Field	Cascaded
0,*	StudyInvestigation	studyInvestigations	Yes
0,*	Sample	samples	Yes
0,*	Keyword	keywords	Yes
0,*	InvestigationParameter	parameters	Yes
0,1	FacilityCycle	facilityCycle
0,*	Shift	shifts	Yes
1,1	InvestigationType	type
0,*	Publication	publications	Yes
0,1	Instrument	instrument
0,*	Dataset	datasets	Yes
1,1	Facility	facility
0,*	InvestigationUser	investigationUsers	Yes

Other fields

Field	Type	Description
visitId	String [255]	Identifier for the visit to which this investigation is related
endDate	Date
summary	String [4000]	Summary or abstract
startDate	Date
doi	String [255]	The Digital Object Identifier associated with this investigation
name	String [255] NOT NULL	A short name for the investigation
title	String [255] NOT NULL	Full title of the investigation
releaseDate	Date	When the data will be made freely available

InvestigationParameter

A parameter associated with an investigation

Uniqueness constraint investigation, type

Relationships

Card	Class	Field	Cascaded	Description
1,1	ParameterType	type		The type of the parameter
1,1	Investigation	investigation		The associated investigation

Other fields

Field	Type	Description
numericValue	Double	The value if the parameter is numeric
dateTimeValue	Date	The value if the parameter is a date
stringValue	String [4000]	The value if the parameter is a string
rangeTop	Double	The maximum value of the numeric parameter that was observed during the measurement period
rangeBottom	Double	The minimum value of the numeric parameter that was observed during the measurement period
error	Double	The error of the numeric parameter

InvestigationType

A type of investigation

Uniqueness constraint name, facility

Relationships

Card	Class	Field	Cascaded	Description
0,*	Investigation	investigations	Yes
1,1	Facility	facility		The facility which has defined this investigation type

Other fields

Field	Type	Description
description	String [255]	A description of this type of investigation
name	String [255] NOT NULL	A short name identifying this type of investigation

InvestigationUser

Many to many relationship between investigation and user

Uniqueness constraint user, investigation

Relationships

Card	Class	Field	Cascaded	Description
1,1	User	user
1,1	Investigation	investigation

Other fields

Field	Type	Description
role	String [255]

Job

A run of an application with its related inputs and outputs

Relationships

Card	Class	Field	Cascaded
1,1	Application	application
0,*	OutputDatafile	outputDatafiles	Yes
0,*	InputDatafile	inputDatafiles	Yes
0,*	OutputDataset	outputDatasets	Yes
0,*	InputDataset	inputDatasets	Yes

Keyword

Must be related to an investigation

Uniqueness constraint name, investigation

Relationships

Card	Class	Field	Cascaded	Description
1,1	Investigation	investigation		The investigation to which this keyword applies

Other fields

Field	Type	Description
name	String [255] NOT NULL	The name of the keyword

NotificationRequest

Registers a request for a JMS notification to be sent out

Uniqueness constraint name

Relationships

Card	Class	Field	Cascaded	Description

Other fields

Field	Type	Description
datatypes	String [255]	A blank separated list of keywords showing what to publish in the notification message. Possible keywords are: NOTIFICATIONNAME - the name given to the notification, USERID - the user name of the person making the API call, ENTITYNAME - the name of the entitity involved in the call, ENTITYID - the id of the entity and QUERY - the search/get string when available
crudFlags	String [4] NOT NULL	Contains letters from the set "CRUD"
destType	DestType NOT NULL	An enum which may be PUBSUB or P2P
what	String [255] NOT NULL	When to send notifications
jmsOptions	String [255]	Currently no options are supported
name	String [255] NOT NULL	A unique name for the notification request. It is not the key so it can be updated.

OutputDatafile

Many to many relationship between data file as output and a job

Relationships

Card	Class	Field	Cascaded	Description
1,1	Job	job
1,1	Datafile	datafile

OutputDataset

Many to many relationship between data set as output and a job

Relationships

Card	Class	Field	Cascaded	Description
1,1	Job	job
1,1	Dataset	dataset

ParameterType

A parameter type with unique name and units

Uniqueness constraint facility, name, units

Relationships

Card	Class	Field	Cascaded	Description
0,*	DatasetParameter	datasetParameters	Yes
0,*	InvestigationParameter	investigationParameters	Yes
0,*	PermissibleStringValue	permissibleStringValues	Yes
0,*	SampleParameter	sampleParameters	Yes
0,*	DatafileParameter	datafileParameters	Yes
1,1	Facility	facility		The facility which has defined this data set type

Other fields

Field	Type	Description
units	String [255]	The name of the parameter type units
maximumNumericValue	Double
minimumNumericValue	Double
unitsFullName	String [255]	The formal name of the parameter type units
applicableToDatafile	boolean	If a parameter of this type may be applied to a data file
valueType	ParameterValueType NOT NULL	enum with possible values: NUMERIC, STRING, DATE_AND_TIME
enforced	boolean	True if constraints are enforced
verified	boolean	If ordinary users are allowed to create their own parameter types this indicates that this one has been approved
description	String [255]	Description of the parameter type
applicableToDataset	boolean	If a parameter of this type may be applied to a data set
name	String [255] NOT NULL	The name of the parameter type
applicableToSample	boolean	If a parameter of this type may be applied to a sample
applicableToInvestigation	boolean	If a parameter of this type may be applied to an investigation

PermissibleStringValue

Permissible value for string parameter types

Uniqueness constraint value, type

Relationships

Card	Class	Field	Cascaded	Description
1,1	ParameterType	type		The parameter type to which this permissible string value applies

Other fields

Field	Type	Description
value	String [255] NOT NULL	The value of the string

Publication

A publication

Relationships

Card	Class	Field	Cascaded	Description
1,1	Investigation	investigation

Other fields

Field	Type	Description
repository	String [255]	The name of a repository where the publication is held
repositoryId	String [255]	The id of the publication within the repository
fullReference	String [511] NOT NULL	A reference in the form to be used for citation
url	String [255]	A URL from which the publication may be downloaded
doi	String [255]	The Digital Object Identifier associated with this publication

RelatedDatafile

Used to represent an arbitrary relationship between data files

Uniqueness constraint sourceDatafile, destDatafile

Relationships

Card	Class	Field	Cascaded	Description
1,1	Datafile	destDatafile
1,1	Datafile	sourceDatafile

Other fields

Field	Type	Description
relation	String [255] NOT NULL	Identifies the type of relationship between the two datafiles - e.g. "COPY"

Rule

An authorization rule

Relationships

Card	Class	Field	Cascaded	Description
0,1	Group	group

Other fields

Field	Type	Description
crudFlags	String [4] NOT NULL	Contains letters from the set "CRUD"
what	String [255]	To what the rules applies

Sample

A sample to be used in an investigation

Uniqueness constraint name, type, investigation

Relationships

Card	Class	Field	Cascaded
0,*	Dataset	datasets	Yes
1,1	Investigation	investigation
0,*	SampleParameter	parameters	Yes
0,1	SampleType	type

Other fields

Field	Type	Description
name	String [255] NOT NULL

SampleParameter

A parameter associated with a sample

Uniqueness constraint sample, type

Relationships

Card	Class	Field	Cascaded	Description
1,1	Sample	sample		The associated sample
1,1	ParameterType	type		The type of the parameter

Other fields

Field	Type	Description
numericValue	Double	The value if the parameter is numeric
dateTimeValue	Date	The value if the parameter is a date
stringValue	String [4000]	The value if the parameter is a string
rangeTop	Double	The maximum value of the numeric parameter that was observed during the measurement period
rangeBottom	Double	The minimum value of the numeric parameter that was observed during the measurement period
error	Double	The error of the numeric parameter

SampleType

A sample to be used in an investigation

Uniqueness constraint name, facility

Relationships

Card	Class	Field	Cascaded	Description
0,*	Sample	samples	Yes
1,1	Facility	facility		The facility which has defined this sample type

Other fields

Field	Type	Description
name	String [255] NOT NULL
safetyInformation	String [4000]	Any safety information related to this sample
molecularFormula	String [255]	The formula written as a string -e.g. C2H6O2 for ethylene glycol

Shift

A period of time related to an investigation

Uniqueness constraint investigation, startDate, endDate

Relationships

Card	Class	Field	Cascaded	Description
1,1	Investigation	investigation

Other fields

Field	Type	Description
startDate	Date NOT NULL
comment	String [255]
endDate	Date NOT NULL

Study

A study which may be related to an investigation

Relationships

Card	Class	Field	Cascaded	Description
0,1	User	user		The user responsible for the study
0,*	StudyInvestigation	studyInvestigations	Yes

Other fields

Field	Type	Description
name	String [255] NOT NULL	The name of the study
description	String [4000]	A description of the study and its purpose
status	StudyStatus	The status of the study. Possible values are: NEW, IN_PROGRESS, COMPLETE, CANCELLED
startDate	Date	The start date of this study

StudyInvestigation

Many to many relationship between study and investigation

Uniqueness constraint study, investigation

Relationships

Card	Class	Field	Cascaded	Description
1,1	Investigation	investigation
1,1	Study	study

User

A user of the facility

Uniqueness constraint name

Relationships

Card	Class	Field	Cascaded
0,*	InvestigationUser	investigationUsers	Yes
0,*	Study	studies	Yes
0,*	InstrumentScientist	instrumentScientists	Yes
0,*	UserGroup	userGroups	Yes

Other fields

Field	Type	Description
name	String [255] NOT NULL	The name of the user to match that provided by the authentication mechanism
fullName	String [255]	May include title

UserGroup

Many to many relationship between user and group

Uniqueness constraint user, group

Relationships

Card	Class	Field	Cascaded	Description
1,1	User	user
1,1	Group	group