4.
Data attributes available
4.1.
CUD attribute set
The CUD attribute set (CAS) comprises a list of attributes which are available by default to all registered users of CUD for all person records in CUD. Some attributes in the CAS are consolidated values from multiple sources, others are single values taken from a single source
|
Name
|
Source/owner
|
Consolidated from
|
| cud:cas:barcode |
Card office |
|
| cud:cas:barcode7 |
Card office
|
|
| cud:cas:external_tel |
Telecoms |
|
| cud:cas:firstname |
|
cud:derived:uas_universitycard:firstname |
| cud:cas:fullname |
|
cud:derived:uas_universitycard:fullname |
| cud:cas:internal_tel |
Telecoms
|
|
| cud:cas:known_as |
|
cud:derived:oucs_registration_email:preferredname |
| cud:cas:lastname |
|
cud:uas_universitycard:famnam |
| cud:cas:middlenames |
|
cud:uas_oss:middlename |
| cud:cas:olis_number |
Libraries |
|
| cud:cas:oxford_email |
OUCS Registration |
|
| cud:cas:sso_username |
OUCS Registration |
|
| cud:cas:suffix |
OSS |
cud:uas_oss:suffix |
| cud:cas:title |
|
cud:uas_university_card:title |
| cud:cas:university_card_status |
Card office
|
|
| cud:cas:university_card_type |
Card office
|
|
| cud:fk:bodleian_record_number |
Libraries |
|
| cud:fk:opendoor_staff_number |
HR |
|
| cud:fk:oss_student_number |
OSS |
|
| cud:fk:oucs_pcode |
OUCS Registration |
|
| cud:fk:telecom_id |
Telecoms |
|
| cud:fk:university_card_sysis |
Card office |
|
4.2.
Complete list of attributes
Additional attributes, not included in the CAS are available on application. You must have a good reason for using additional attributes, access to which will be considered in consultation with the data owner.
The following table shows additional consolidated attributes:
|
Name
|
Consolidated from
|
| cud:consolidated:external_email |
cud:uas_oss:alternativeEmail |
| cud:consolidated:dob |
cud:uas_universitycard:dob |
| cud:consolidated:universitycard_sub_category |
cud:uas:universitycard_sub_category |
| cud:consolidated:universitycard_sub_category_expanded |
cud:uas:universitycard_sub_category_expanded |
The following table shows all attributes, their source and whether they are included in the CAS.
|
Name
|
Source/owner
|
In CAS
|
| cud:fk:universitycard_sysis |
Card Office |
Y |
| cud:uas_universitycard:title |
Card Office |
Y (consolidated) |
| cud:uas_universitycard:fullpernam |
Card Office |
Y (consolidated) |
| cud:derived:uas_universitycard:firstname |
Card Office |
Y (consolidated) |
| cud:derived:uas_universitycard:firstname |
Card Office |
Y (consolidated} |
| cud:derived:uas_universitycard:middlenames |
Card Office |
Y (consolidated) |
| cud:uas_universitycard:famnam |
Card Office |
Y (consolidated) |
| cud:uas_universitycard:known_as |
Card Office |
Y (consolidated) |
| cud:uas_universitycard:dob |
Card Office |
|
| cud:cas:universitycard_status |
Card Office |
Y |
| cud:cas:universitycard_type |
Card Office |
Y |
| cud:uas:universitycard_sub_category |
Card Office |
|
| cud:cas:barcode |
Card Office |
Y |
| cud:derived:uas_universitycard:barcode7 |
Card Office |
Y |
| cud:uas:universitycard_comp_date |
Card Office |
|
| cud:uas:universitycard_start_date |
Card Office |
|
| cud:uas:universitycard_mifare_id |
Card Office |
|
| cud:uas:universitycard_paxton_id |
Card Office |
|
| cud:uas:universitycard_sub_category_expanded |
Card Office |
|
| cud:uas:universitycard_sub_category_expanded_name |
Card Office |
|
| cud:uas:universitycard_card_type_expanded |
Card Office |
|
| cud:fk:oss_student_number |
OSS |
Y |
| cud:uas_oss:prefix |
OSS |
|
| cud:uas_oss:suffix |
OSS |
Y(consolidated ) |
| cud:uas_oss:middlename |
OSS |
Y(consolidated ) |
| cud:uas_oss:lastname |
OSS |
Y(consolidated) |
| cud:uas_oss:firstname |
OSS |
Y(consolidated) |
| cud:uas_oss:preferred_given_name |
OSS |
|
| cud:derived:uas_oss:fullname |
OSS |
|
| cud:uas_oss:alternativeEmail |
OSS |
|
| cud:uas_oss:dateofbirth |
OSS |
|
| cud:uas_oss:gender |
OSS |
|
| cud:uas_oss:ucasid |
OSS |
|
| cud:uas_oss:college_offer_status |
OSS |
|
| cud:uas_oss:fee_status_code |
OSS |
|
| cud:uas_oss:fee_category |
OSS |
|
| cud:uas_oss:hesa_dom |
OSS |
|
| cud:uas_oss:prog_attmpt_status |
OSS |
|
| cud:uas_oss:divcode |
OSS |
|
| cud:uas_oss:divdesc |
OSS |
|
| cud:uas_oss:deptcode |
OSS |
|
| cud:uas_oss:deptdesc |
OSS |
|
| cud:uas_oss:prog_start_date |
OSS |
|
| cud:uas_oss:caltype |
OSS |
|
| cud:uas_oss:attendance_type |
OSS |
|
| cud:uas_oss:attendance_mode |
OSS |
|
| cud:uas_oss:clsstnding |
OSS |
|
| cud:uas_oss:progcode |
OSS |
|
| cud:uas_oss:year_of_student |
OSS |
|
| cud:uas_oss:unit_set_cd |
OSS |
|
| cud:uas_oss:mobile_phone_number |
OSS |
|
| cud:uas_oss:contact_phone_number |
OSS |
|
| cud:uas_oss:deptdesc_mapped |
OSS |
|
| cud:fk:bodleian_record_number |
Libraries |
|
| cud:bodleian_readers:title |
Libraries |
|
| cud:bodleian_readers:given_names |
Libraries |
|
| cud:bodleian_readers:family_name |
Libraries |
|
| cud:cas:olis_number |
Libraries |
|
| cud:bodleian_readers:dateofbirth |
Libraries |
|
| cud:bodleian_readers:email |
Libraries |
|
| cud:cas:olis_number |
Libraries |
Y |
| cud:derived:bodleian_readers:firstname |
Libraries |
|
| cud:derived:bodleian_readers:fullname |
Libraries |
|
| cud:derived:bodleian_readers:middlenames |
Libraries |
|
| cud:fk:opendoor_staff_number |
HR |
Y |
| cud:uas_opendoor:title |
HR |
Y(consolidated) |
| cud:uas_opendoor:initia |
HR |
Y(consolidated) |
| cud:uas_opendoor:middle_name |
HR |
Y(consolidated) |
| cud:uas_opendoor:surname |
HR |
Y(consolidated) |
| cud:uas_opendoor:forename |
HR |
Y(consolidated) |
| cud:uas_opendoor:preferred_name |
HR |
Y(consolidated) |
| cud:uas_opendoor:person_birth_date |
HR |
|
| cud:derived:uas_opendoor:fullname |
HR |
|
| cud:cas:oxford_email |
OUCS Registration |
Y |
| cud:cas:sso_username |
OUCS Registration |
Y |
| cud:fk:oucs_pcode |
OUCS Registration |
Y |
| cud:oucs:reg_comp_date |
OUCS Registration |
|
| cud:derived:oucs_registration_email:preferredname |
OUCS Registration |
|
| cud:fk:telecom_id |
Telecoms |
Y |
| cud:cas:external_tel |
Telecoms |
Y |
| cud:cas:internal_tel |
Telecoms |
Y |
4.3. Requesting access to additional attributes
Please use the following email template to request access to additional attributes replacing elements in <> with your details:
To: sysdev@oucs.ox.ac.uk
Subject: Request for additional CUD attributes
Please supply access to additional CUD attributes as follows:
Name: <your name>
SSO username/service principal name: <username or principal>
Additional attributes requested:
ITSS: Y/N
Reason for access:
SSO username/service principal name is the name of the login which requires access to the additional attributes. In the CUD UI this will be an SSO username. For other interfaces this will be the kerberos service principal name granted which has already been granted access to CUD, normally in the form cud/<host fqdn>@OX.AC.UKAdditional attributes requested is the list of name of the additional requested, taken from the complete list of attributesITSS should be answered Y/N depending on whether you appear in the ITSS registerReason for access is required whether or not you are ITSS
4.4.
Affiliations
In addition to attributes, CUD stores affiliations, which reflect the relationship of a person with the University.
CUD models an unlimited number of as affiliations with the following components:
- Status (coarse grained)
- Unit
- Source
- Start date
- End date
- Date last updated
Primary data systems have different status codes and different codes/acronyms for units
Status codes are stored “as-is” and not decoded, is there is no status it is stored as “unknown”
Unit codes are stored as received from the primary data system, but an attempt is also made to map them to a common acronym and name, so a single affiliation (from University Card) is stored in different forms:
- MC@EN
- MC@OUCS
- MC@Computing Services
CUD exposes affiliations in the form current_affiliations for convenience. It lists units with which a person has a current affiliation from any source
- Status is not listed
- Start, end and last updated dates not exposed
- Easy to search
- Easy to consume
CUD also exposes affiliations in the form scoped_affiliation where additional data is required. This includes all data held for an affiliation
- For “flat” format (e.g. a CSV) the elements are concatenated with ; delimiters
- Where there are multiple affiliations this can become difficult to process!
- For “structured” formats elements are in a defined structure and so easier to process
- Scoped_affiliation includes past, current, and (potentially) future affiliations
Affiliations can be considered part of the CAS, since all registered CUD users are able to view them. In many cases start and end dates not specifically included in the CAS are available as a component of an affiliation.
4.5.
Data formats available
CUD supports the following data formats on interfaces:
Person records can be constructed with as “flat” or “structured”:
- “Flat”: not very rich, lacks metadata, can be hard to interpret
- “Structured”: rich, includes metadata, easier to interpret but requires processing on the client-side
The following table shows which data formats and structures are supported on which interfaces.
|
Interface
|
Data format
|
Flat
|
Structured
|
|
CUD UI
|
XML |
XML |
XML |
|
REST
|
XML |
XML |
XML |
|
SOAP query
|
XML |
XML
|
XML |
|
SOAP push
|
XML |
XML |
XML |
|
SQL Push
|
SQL
|
SQL |
|
|
LDAP query
|
LDAP |
LDAP |
|
|
LDAP push
|
LDAP |
LDAP |
|
- You are encouraged to use the CUD UI to view the different data formats and structures in order to determine which is best for a specific purpose.
Up: Contents Previous: 3.
Requesting use of a CUD interface