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

CardClassFieldCascadedDescription
0,*JobjobsYes

Other fields

FieldTypeDescription
nameString [255]A short name for the software - e.g. mantid
versionString [255]

Datafile

A data file

Uniqueness constraint name, location, dataset

Relationships

CardClassFieldCascadedDescription
0,1DatasetdatasetThe dataset which holds this file
0,*RelatedDatafilesourceDatafilesYes
0,*OutputDatafileoutputDatafilesYes
0,*InputDatafileinputDatafilesYes
0,*RelatedDatafiledestDatafilesYes
0,*DatafileParameterparametersYes
0,1DatafileFormatdatafileFormat

Other fields

FieldTypeDescription
nameString [255] NOT NULLA name given to the file
descriptionString [255]A full description of the file contents
fileSizeLongExpressed in bytes
doiString [255]The Digital Object Identifier associated with this data file
datafileCreateTimeDateDate of creation of the actual file rather than storing the metadata
locationString [255]The logical location of the file - which may also be the physical location
checksumString [255]Checksum of file represented as a string
datafileModTimeDateDate of modification of the actual file rather than of the metadata

DatafileFormat

A data file format

Uniqueness constraint facility, name, version

Relationships

CardClassFieldCascadedDescription
1,1FacilityfacilityThe facility which has defined this format
0,*DatafiledatafilesYesFiles with this format

Other fields

FieldTypeDescription
descriptionString [255]An informal description of the format
nameString [255] NOT NULLA short name identifying the format -e.g. "mp3" within the facility
versionString [255]The version if needed. The version code may be part of the basic name
typeString [255]Holds the underlying format - such as binary or text

DatafileParameter

A parameter associated with a data file

Uniqueness constraint datafile, type

Relationships

CardClassFieldCascadedDescription
1,1ParameterTypetypeThe type of the parameter
1,1DatafiledatafileThe associated data file

Other fields

FieldTypeDescription
numericValueDoubleThe value if the parameter is numeric
dateTimeValueDateThe value if the parameter is a date
stringValueString [4000]The value if the parameter is a string
rangeTopDoubleThe maximum value of the numeric parameter that was observed during the measurement period
rangeBottomDoubleThe minimum value of the numeric parameter that was observed during the measurement period
errorDoubleThe error of the numeric parameter

Dataset

A collection of data files and part of an investigation

Uniqueness constraint sample, investigation, name, type

Relationships

CardClassFieldCascadedDescription
0,1Samplesample
1,1DatasetTypetype
0,1Investigationinvestigation
0,*DatafiledatafilesYesThe data files within the dataset
0,*OutputDatasetoutputDatasetsYes
0,*DatasetParameterparametersYes
0,*InputDatasetinputDatasetsYes

Other fields

FieldTypeDescription
completebooleanMay be set to true when all data files and parameters have been added to the data set. The precise meaning is facility dependent.
descriptionString [255]An informal description of the data set
nameString [255] NOT NULLA short name for the data set
doiString [255]The Digital Object Identifier associated with this data set
startDateDate
locationString [255]Identifies a location from which all the files of the data set might be accessed. It might be a directory
endDateDate

DatasetParameter

A parameter associated with a data set

Uniqueness constraint dataset, type

Relationships

CardClassFieldCascadedDescription
1,1ParameterTypetypeThe type of the parameter
1,1DatasetdatasetThe associated data set

Other fields

FieldTypeDescription
numericValueDoubleThe value if the parameter is numeric
dateTimeValueDateThe value if the parameter is a date
stringValueString [4000]The value if the parameter is a string
rangeTopDoubleThe maximum value of the numeric parameter that was observed during the measurement period
rangeBottomDoubleThe minimum value of the numeric parameter that was observed during the measurement period
errorDoubleThe error of the numeric parameter

DatasetType

A type of data set

Uniqueness constraint facility, name

Relationships

CardClassFieldCascadedDescription
0,*DatasetdatasetsYes
1,1FacilityfacilityThe facility which has defined this data set type

Other fields

FieldTypeDescription
nameString [255] NOT NULLA short name identifying this data set type within the facility
descriptionString [255]A description of this data set type

Facility

An experimental facility

Uniqueness constraint name

Relationships

CardClassFieldCascadedDescription
0,*DatasetTypedatasetTypesYes
0,*DatafileFormatdatafileFormatsYes
0,*ParameterTypeparameterTypesYes
0,*InstrumentinstrumentsYes
0,*FacilityCyclefacilityCyclesYes
0,*InvestigationTypeinvestigationTypesYes
0,*InvestigationinvestigationsYes
0,*SampleTypesampleTypesYes

Other fields

FieldTypeDescription
daysUntilReleaseIntegerThe number of days before data is made freely available after collecting it.
fullNameString [255]The full name of the facility
descriptionString [1023]A description of this facility
nameString [255] NOT NULLA short name identifying this facility
urlString [255]A URL associated with this facility

FacilityCycle

An operating cycle within a facility

Uniqueness constraint facility, name

Relationships

CardClassFieldCascadedDescription
0,*InvestigationinvestigationsYes
1,1FacilityfacilityThe facility which has this cycle

Other fields

FieldTypeDescription
endDateDateEnd of cycle
startDateDateStart of cycle
nameString [255] NOT NULLA short name identifying this facility cycle within the facility
descriptionString [255]A description of this facility cycle

Group

A group of users

Uniqueness constraint name

Relationships

CardClassFieldCascadedDescription
0,*RulerulesYes
0,*UserGroupuserGroupsYes

Other fields

FieldTypeDescription
nameString [255] NOT NULLA short name identifying this group of users

InputDatafile

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

Relationships

CardClassFieldCascadedDescription
1,1Jobjob
1,1Datafiledatafile

InputDataset

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

Relationships

CardClassFieldCascadedDescription
1,1Jobjob
1,1Datasetdataset

Instrument

Used by a user within an investigation

Uniqueness constraint facility, name

Relationships

CardClassFieldCascadedDescription
1,1FacilityfacilityThe facility which has this instrument
0,*InstrumentScientistinstrumentScientistsYes
0,*InvestigationinvestigationsYes

Other fields

FieldTypeDescription
nameString [255] NOT NULLA short name identifying this instrument within the facility
descriptionString [4000]A description of this instrument
fullNameString [255]The formal name of this instrument
typeString [255]

InstrumentScientist

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

Uniqueness constraint user, instrument

Relationships

CardClassFieldCascadedDescription
1,1Useruser
1,1Instrumentinstrument

Investigation

An investigation or experiment

Uniqueness constraint name, visitId, facilityCycle, instrument

Relationships

CardClassFieldCascadedDescription
0,*PublicationpublicationsYes
0,*InvestigationUserinvestigationUsersYes
1,1InvestigationTypetype
0,1FacilityCyclefacilityCycle
0,*ShiftshiftsYes
0,*SamplesamplesYes
0,*InvestigationParameterparametersYes
0,*KeywordkeywordsYes
0,*DatasetdatasetsYes
0,*StudyInvestigationstudyInvestigationsYes
1,1Facilityfacility
0,1Instrumentinstrument

Other fields

FieldTypeDescription
visitIdString [255]Identifier for the visit to which this investigation is related
endDateDate
summaryString [4000]Summary or abstract
startDateDate
doiString [255]The Digital Object Identifier associated with this investigation
nameString [255] NOT NULLA short name for the investigation
titleString [255] NOT NULLFull title of the investigation
releaseDateDateWhen the data will be made freely available

InvestigationParameter

A parameter associated with an investigation

Uniqueness constraint investigation, type

Relationships

CardClassFieldCascadedDescription
1,1ParameterTypetypeThe type of the parameter
1,1InvestigationinvestigationThe associated investigation

Other fields

FieldTypeDescription
numericValueDoubleThe value if the parameter is numeric
dateTimeValueDateThe value if the parameter is a date
stringValueString [4000]The value if the parameter is a string
rangeTopDoubleThe maximum value of the numeric parameter that was observed during the measurement period
rangeBottomDoubleThe minimum value of the numeric parameter that was observed during the measurement period
errorDoubleThe error of the numeric parameter

InvestigationType

A type of investigation

Uniqueness constraint name, facility

Relationships

CardClassFieldCascadedDescription
0,*InvestigationinvestigationsYes
1,1FacilityfacilityThe facility which has defined this investigation type

Other fields

FieldTypeDescription
descriptionString [255]A description of this type of investigation
nameString [255] NOT NULLA short name identifying this type of investigation

InvestigationUser

Many to many relationship between investigation and user

Uniqueness constraint user, investigation

Relationships

CardClassFieldCascadedDescription
1,1Useruser
1,1Investigationinvestigation

Other fields

FieldTypeDescription
roleString [255]

Job

A run of an application with its related inputs and outputs

Relationships

CardClassFieldCascadedDescription
0,*OutputDatafileoutputDatafilesYes
0,*InputDatafileinputDatafilesYes
0,*InputDatasetinputDatasetsYes
1,1Applicationapplication
0,*OutputDatasetoutputDatasetsYes

Keyword

Must be related to an investigation

Uniqueness constraint name, investigation

Relationships

CardClassFieldCascadedDescription
1,1InvestigationinvestigationThe investigation to which this keyword applies

Other fields

FieldTypeDescription
nameString [255] NOT NULLThe name of the keyword

NotificationRequest

Registers a request for a JMS notification to be sent out

Uniqueness constraint name

Relationships

CardClassFieldCascadedDescription

Other fields

FieldTypeDescription
datatypesString [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
crudFlagsString [4] NOT NULLContains letters from the set "CRUD"
destTypeDestType NOT NULLAn enum which may be PUBSUB or P2P
whatString [255] NOT NULLWhen to send notifications
jmsOptionsString [255]Currently no options are supported
nameString [255] NOT NULLA 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

CardClassFieldCascadedDescription
1,1Jobjob
1,1Datafiledatafile

OutputDataset

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

Relationships

CardClassFieldCascadedDescription
1,1Datasetdataset
1,1Jobjob

ParameterType

A parameter type with unique name and units

Uniqueness constraint facility, name, units

Relationships

CardClassFieldCascadedDescription
0,*SampleParametersampleParametersYes
1,1FacilityfacilityThe facility which has defined this data set type
0,*InvestigationParameterinvestigationParametersYes
0,*DatafileParameterdatafileParametersYes
0,*DatasetParameterdatasetParametersYes
0,*PermissibleStringValuepermissibleStringValuesYes

Other fields

FieldTypeDescription
unitsString [255]The name of the parameter type units
maximumNumericValueDouble
minimumNumericValueDouble
unitsFullNameString [255]The formal name of the parameter type units
applicableToDatafilebooleanIf a parameter of this type may be applied to a data file
valueTypeParameterValueType NOT NULLenum with possible values: NUMERIC, STRING, DATE_AND_TIME
enforcedbooleanTrue if constraints are enforced
verifiedbooleanIf ordinary users are allowed to create their own parameter types this indicates that this one has been approved
descriptionString [255]Description of the parameter type
applicableToDatasetbooleanIf a parameter of this type may be applied to a data set
nameString [255] NOT NULLThe name of the parameter type
applicableToSamplebooleanIf a parameter of this type may be applied to a sample
applicableToInvestigationbooleanIf a parameter of this type may be applied to an investigation

PermissibleStringValue

Permissible value for string parameter types

Uniqueness constraint value, type

Relationships

CardClassFieldCascadedDescription
1,1ParameterTypetypeThe parameter type to which this permissible string value applies

Other fields

FieldTypeDescription
valueString [255] NOT NULLThe value of the string

Publication

A publication

Relationships

CardClassFieldCascadedDescription
1,1Investigationinvestigation

Other fields

FieldTypeDescription
repositoryString [255]The name of a repository where the publication is held
repositoryIdString [255]The id of the publication within the repository
fullReferenceString [511] NOT NULLA reference in the form to be used for citation
urlString [255]A URL from which the publication may be downloaded
doiString [255]The Digital Object Identifier associated with this publication

RelatedDatafile

Used to represent an arbitrary relationship between data files

Uniqueness constraint sourceDatafile, destDatafile

Relationships

CardClassFieldCascadedDescription
1,1DatafiledestDatafile
1,1DatafilesourceDatafile

Other fields

FieldTypeDescription
relationString [255] NOT NULLIdentifies the type of relationship between the two datafiles - e.g. "COPY"

Rule

An authorization rule

Relationships

CardClassFieldCascadedDescription
0,1Groupgroup

Other fields

FieldTypeDescription
crudFlagsString [4] NOT NULLContains letters from the set "CRUD"
whatString [255]To what the rules applies

Sample

A sample to be used in an investigation

Uniqueness constraint name, type, investigation

Relationships

CardClassFieldCascadedDescription
0,1SampleTypetype
0,*DatasetdatasetsYes
0,*SampleParameterparametersYes
1,1Investigationinvestigation

Other fields

FieldTypeDescription
nameString [255] NOT NULL

SampleParameter

A parameter associated with a sample

Uniqueness constraint sample, type

Relationships

CardClassFieldCascadedDescription
1,1ParameterTypetypeThe type of the parameter
1,1SamplesampleThe associated sample

Other fields

FieldTypeDescription
numericValueDoubleThe value if the parameter is numeric
dateTimeValueDateThe value if the parameter is a date
stringValueString [4000]The value if the parameter is a string
rangeTopDoubleThe maximum value of the numeric parameter that was observed during the measurement period
rangeBottomDoubleThe minimum value of the numeric parameter that was observed during the measurement period
errorDoubleThe error of the numeric parameter

SampleType

A sample to be used in an investigation

Uniqueness constraint name, facility

Relationships

CardClassFieldCascadedDescription
0,*SamplesamplesYes
1,1FacilityfacilityThe facility which has defined this sample type

Other fields

FieldTypeDescription
nameString [255] NOT NULL
safetyInformationString [4000]Any safety information related to this sample
molecularFormulaString [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

CardClassFieldCascadedDescription
1,1Investigationinvestigation

Other fields

FieldTypeDescription
startDateDate NOT NULL
commentString [255]
endDateDate NOT NULL

Study

A study which may be related to an investigation

Relationships

CardClassFieldCascadedDescription
0,1UseruserThe user responsible for the study
0,*StudyInvestigationstudyInvestigationsYes

Other fields

FieldTypeDescription
nameString [255] NOT NULLThe name of the study
descriptionString [4000]A description of the study and its purpose
statusStudyStatusThe status of the study. Possible values are: NEW, IN_PROGRESS, COMPLETE, CANCELLED
startDateDateThe start date of this study

StudyInvestigation

Many to many relationship between study and investigation

Uniqueness constraint study, investigation

Relationships

CardClassFieldCascadedDescription
1,1Studystudy
1,1Investigationinvestigation

User

A user of the facility

Uniqueness constraint name

Relationships

CardClassFieldCascadedDescription
0,*InvestigationUserinvestigationUsersYes
0,*InstrumentScientistinstrumentScientistsYes
0,*UserGroupuserGroupsYes
0,*StudystudiesYes

Other fields

FieldTypeDescription
nameString [255] NOT NULLThe name of the user to match that provided by the authentication mechanism
fullNameString [255]May include title

UserGroup

Many to many relationship between user and group

Uniqueness constraint user, group

Relationships

CardClassFieldCascadedDescription
1,1Useruser
1,1Groupgroup