Skip to main content

Aggregate Offshore record 2017/18 - File structure

Back to C17052

Version 1.0 Produced 2017-10-31

The physical file structure to be returned to HESA is identical to the data model, shown in the diagram below.

HESA Aggregate offshore record entity relationship diagram

Data model

Note: A HEP making a nil-return will have no provision.

Data format

Data must be returned to HESA as an XML file. XML is the eXtensible Markup Language and is a W3C recommendation. There are many XML training resources on the web, including the W3C Tutorial on XML and the resources of W3Schools.

Files must be encoded with UTF-8 and schema validation will be in place to ensure this. HEPs must specify the encoding used in their XML files in the first line of the file (i.e. <?xml version="1.0" encoding="UTF-8" ?>) and to ensure that their files are actually saved with that encoding. If XML files are edited with some text editors and the encoding is not specified or does not match the actual file encoding, there may be problems when submitting these files for validation.

Ordering of attributes for submission

The order in which entities and fields should be submitted is governed by the Cyy052.xsd file, which is ordered according to the following principles:

  • Entities are presented in parent-child order, starting with the 'Provider' entity.
  • Fields within entities are presented in the order of primary key fields, candidate key fields, foreign key fields, and non-key fields.
  • Child entities then follow.
  • Each field or entity within a parent entity is presented in alphabetical order to aid their location.

Need help?

Contact Liaison by email or on 01242 211144.