Metadata Schema
The metadata schema for equipment data used on this website acts as a bridge between the schema employed by SAP and the Uniquip schema required by JISC. The Uniquip schema is going to change soon to include more detail and to align it more closely with the Datacite schema and the PIDINST schema. There is already a mapping between the Datacite and PIDINST schemas in the PIDINST Metadata Schema GitHub repository.
Current mapping between SAP and Uniquip
The followiung tables show mapping between the schema used on this site and the original SAP field and Uniquip schema.
Notes
- SAP data does not contain a short description of equipment - the “Equipment Description” field in SAP is used for the name of the equipment. All data in the description fields for equipment are taken from the old ESMS system
- SAP data does not contain any images of equipment - this is all taken from the old ESMS system
- The uniquip schema is used for both equipment and facilities (i.e. laboratories containing equipment) and distinguishes between them using a Type field. Although some items in SAP should perhaps be classed as facilities, all items are classed as equipment.
- For information about the extent to which the current data in SAP is complete, see the coverage page
Equipment fields
| Field | Description | SAP field | Uniquip field |
|---|---|---|---|
| identifier | Unique ID for the equipment | Equipment | ID |
| name | Name for the equipment | Equipment Description | Name |
| description | Short description of the equipment | - | Description |
| manufacturer.name | Name of manufacturer | Manufacturer | - |
| model | Model number | Model number | - |
| serialNumber | Manufacturer’s Serial Number | ManufactSerialNumber | - |
| category.name | Category (from N8 Taxonomy terms). SAP fields need to be mapped to terms in the taxonomy. | Class | Technique |
| images | Images of the equipment | - | Photo |
| location.identifier | ID for the location of the equipment | Functional Location | - |
| location.name | Name for the location of the equipment | Location Description | Site Location |
| url | URL of a web page giving information about the equipment | - | Web Address |
| - | Details of support available for the use of this facility or equipment | - | Service Level |
| - | Name or reference number of the building where the equipment or facility is based | - | Building |
| - | The URL of a Wikipedia page for the location | - | Location |
| - | Type of item - defined as either “equipment” or “facility” | - | Type |
| - | ID of a facility which hosts the equipment | - | Related Facility ID |
| location.identifier | ID of the location of the equipment in SAP | Functional Location | - |
| - | SAP Inventory Number | Inventory number | - |
Organisation / Contact fields
SAP uses the “Function” field to describe the relationship between a member of staff or a department and the piece of equipment. This can be “ZO” (Equipment Owner), “ZS” (Owner School/Dept)” or “ZT” (Technical Owner).
| Field | Description | SAP field | Uniquip field |
|---|---|---|---|
| owner.identifier | Owner’s ID | Partner | - |
| owner.name | Owner’s full name. If the ZO function is present in SAP, SAP fields for “First name” and “Last name” are concatenated here | [First Last] | Contact Name |
| owner.givenName | Owner’s first name | First name | - |
| owner.familyName | Owner’s surname | Last Name | - |
| owner.telephone | Owner’s telephone number | - | Contact Telephone |
| owner.email | Owner’s email address | - | Contact Email |
| owner.url | Web page URL for contact information | - | Contact URL |
| owner_organisation.identifier | If the ZS Function is present in SAP, Partner is used here | Partner | - |
| owner_organisation.name | Organisation full name. If the ZS Function is present in SAP, Last name is used here | Last name | Department |
| contact.identifier | Contact ID | Partner | - |
| contact.name | Contact person’s full name. If the ZT function is present in SAP, SAP fields for “First name” and “Last name” are concatenated here | [First Last] | Secondary Contact Name |
| contact.givenName | Owner’s first name | First name | - |
| contact.familyName | Owner’s surname | Last Name | - |
New Uniquip (draft) schema
| Section | Field | Description | Occurence | Obligation |
|---|---|---|---|---|
| 1.1 | type | Either “equipment” or “facility” | 0-1 | Recommended |
| 1.2 | institutionID | Uniquie identifier within the institution | 1 | Mandatory |
| 1.3 | name | Name of the equipment | 1 | Mandatory |
| 1.4 | description | Technical description and capabilities | 0-1 | Mandatory |
| 2.1 | manufacturer | The manufacturer of the equipment | 1-n | Mandatory |
| 2.1.1 | manufacturerID | Identifier for the manufacturer | 1 | Optional |
| 2.2 | model | Name of the model or type of device as attributed by the manufacturer | 0-1 | Optional |
| 2.2.1 | modelID | Identifier used to identify the model by the manufacturer | 1 | Optional |
| 2.3 | commissionedDate | Date equipment was commissioned (ISO 8601) | 0-1 | Recommended |
| 2.4 | decommissionedDate | Date equipment was decommissioned (ISO 8601) | 0-1 | Recommended |
| 2.5 | measuredVariable | What the equipment measures | 0-n | Recommended |
| 2.6 | subject | Subject(s) equipment is relevant to, as defined by the institution | 0-n | Recommended |
| 2.7 | infraportalDiscipline | Discipline(s) equipment is relevant to, as defined by the UKRI Infraportal | 0-n | Mandatory |
| 3.1 | contactName | Name of contact person | 0-n | Optional |
| 3.1.1 | contactID | Identifier for contact (ORCID) | 1 | Optional |
| 3.2 | contactEmail | contact email for enquiries | 1 | Recommended |
| 3.3 | managingDepartment | Name of the department that manages the equipment | 0-n | Recommended |
| 3.3.1 | managingDepartmentID | Identifier used to identify the department | 1 | Optional |
| 3.4 | managingFacility | Name of the facility that manages the equipment | 0-n | Recommended |
| 3.4.1 | managingFacilityID | Idetifier of the facility that manages the equipment (ROR) | 0-n | Recommended |
| 3.5 | location | Geographical location (address, place name) | 1 | Recommended |
| 3.6 | postcode | postcode for the location | 1 | Recommended |
| 3.7 | remote | Whether the equipment can be accessed / used remotely (Yes/No) | 1 | Recommended |
| 4.1 | photo | URL(s) of photograph(s) of equipment | 0-n | Optional |
| 4.2 | webAddress | URL(s) of web pages about the equipment | 0-n | Optional |
| 4.3 | researchOutputs | Link(s) to research output(s) generated by the equipment | 0-n | Optional |
| 4.4 | documentation | Link(s) to documentation for the equipment | 0-n | Optional |
| 4.5 | relatedInfo | Link(s) to related information about the equipment | 0-n | Optional |
| 5.1 | funder | Name of the organisation that funded the equipment | 0-n | Recommeded |
| 5.1.1 | funderID | Identifier of the organisation that funded the equipment | 1 | Optional |
| 5.2 | awardName | Name of the funding award | 1 | Optional |
| 5.2.1 | awardID | Identifier for the funding award | 1 | Optional |
| 5.3 | awardDate | Date of funding award (ISO 8601) | 1 | Optional |
| 5.4 | overUKRI | Equipment value at purchase was over UKRI reporting threshold of £138,000 (Yes / No ) | 1 | Optional |