draft
Info |
---|
See also: SOR-Registry Core Schema Specification |
Schema Elements
For each product, the description indicates where that attribute attaches to the data model for purposes of developing a core schema. Some implementation-oriented details are skipped or normalized to facilitate discussion.
Attributes flagged (*) were identified in the Detailed Use Cases as likely common attributes.
Extensible Controlled Vocabularies provide a base set of common values, but additional may be defined on a per-installation basis.
Note |
---|
The proposed schema does not require any particular attributes. Role attributes may be represented at Role or Person levels. |
Attribute | Proposal | Multi-Valued? | Extensible Controlled Vocabulary | COmanage | CPR | OpenRegistry | KIM | eduPerson | IMS Global | OpenSocial | PESC | SCIM 2.0 |
---|---|---|---|---|---|---|---|---|---|---|---|---|
Person | Core |
|
| top | top | top | top (Entity) | top | top | top |
| top (User) |
Role | Core |
|
| Person |
| Person | Person (8) |
|
|
|
|
|
affiliation* | Core | One per Role | (14)
| Role, Person (2) | Person | Role | Person | Person | Person (institutionroletype) |
|
| Person (userType and/or roles) |
date of birth* | Core |
|
|
| Person | Person | Person |
| Person | Person |
|
|
gender* | Core |
|
|
| Person | Person | Person |
| Person | Person |
|
|
gender change | custom extension |
|
|
|
|
| Person |
|
|
|
|
|
org / department* | Core | Yes |
| Role, Person |
| Role | Person | Person |
| Person |
| Person |
campus* | Core | One per parent object |
|
| Address | Department | Person |
|
|
|
|
|
photo | Core | Yes |
|
| Person (binary) |
|
|
| Person | Person (URL) |
| Person (URL) |
sponsor* | Core | One per Role |
| Role |
| Role |
|
|
|
|
|
|
title* | Core | One per Role (16) |
| Role, Person | tbd | Role |
| Person |
|
|
| Person |
valid from / through* | Core | Per Role |
| Role | Person (3) | Role (11) |
|
|
|
|
|
|
hire / termination (9) | Core | Per Role |
|
|
| Role |
|
|
|
|
|
|
status (10) | Core, with SOR type-specific vocabularies | Per Role |
| Role (Limited) |
| Role | Person |
|
|
|
|
|
termination reason | Core, with SOR type-specific vocabularies | Per Role |
|
|
| Role |
|
|
|
|
|
|
percent time* | Core | Per Role |
|
|
| Role |
|
|
|
|
|
|
leave of absence | Core | Per Role |
|
|
| Role | Person |
|
|
|
|
|
ethnicity* | Core |
|
|
| Planned |
| Person |
| Person (demographics) | Person |
|
|
citizenship* | Core |
|
| Planned |
| Person |
|
|
|
|
| |
visa status* | Core |
|
|
| Planned |
| Person |
|
|
|
|
|
employee type | HR | One per Role |
|
|
|
| Person |
|
|
|
|
|
salary | custom extension |
|
|
|
|
| Person |
|
|
|
|
|
marital status* | custom extension |
|
|
|
|
| Person |
|
|
|
|
|
deceased | use status field or custom extension |
|
|
|
|
| Person |
|
|
|
|
|
preferred language | custom extension |
|
|
|
|
| Person | Person |
|
|
| Person |
birth location | custom extension |
|
|
|
|
| Person |
|
|
|
|
|
directory release* | Core (but perhaps more general) |
|
|
| confidentiality? | Person (11) |
|
|
|
|
|
|
residence hall* | Student |
|
|
|
| (6) |
|
|
|
|
|
|
class year* | Student |
|
|
|
| (6) |
|
|
|
|
|
|
course membership | Student | Yes | (15) |
|
|
|
|
|
|
|
|
|
Address* | Core | Yes |
| Person, Role | Person | Role | Role | Person | Person | Person |
| Person |
line1 |
|
| Address | Address | Address | Address | Address | Address | Address |
| Address | |
Email Address* | Core | Yes |
| Person | Person | Role (5) | Role | Person | Person | Person |
| Person |
Identifier* | Core, with custom typing | Yes |
| Person | Person (4) | Person |
| Person | Person | Person |
| Person |
Identity Proofing | Core | Yes? |
| tbd | Person |
|
| Person |
|
|
|
|
Name* | Core | Yes |
| Person | Person | Person | Person | Person | Person | Person |
| Person |
honorific / prefix | Components and/or Display String? |
|
| Name | Name | Name | Name |
| Person | Person |
| Name |
Telephone Number* | Core | Yes |
| Person, Role | Person | Role (5) | Role | Person | Person | Person |
| Person |
URL | Core | Yes |
|
|
| Role |
|
| Person | Person |
| Person |
Extended Attributes (1) | custom extension | Varies |
| Role |
| (6) |
|
| Person (extension) |
|
|
|
Element Metadata
- Localization (eg: attribute value is EN_US or JP_JP)
- Type (eg: home, office; eppn, netid; etc)
- Attribute Release Policy? (eg: ok-to-publish-my-phone-number)
1 Attributes that are defined in a local installation but are not part of the standard/default data model.
2 COmanage stores organizational and VO identity differently, thus some attributes are attached both to a Person object (for org identities) and a Role object (for VO identities).
3 CPR has valid from / through on all data elements.
4 Various specific tables, such as userid, psu_id, etc.
5 An additional "contact email" and "contact phone" is attached to the Person object.
6 Various additional data elements, including support for extended attributes, were designed but are not currently implemented.
7 Also need to convey deprecated (ie: merged) identifiers.
8 Child of Person (Entity) is called Entity Ent. Unclear that this is functionally a Role equivalent. There are also separate role tables.
9 Or any other role-specific start/end dates (such as matriculation/graduation) that may not exactly map to valid from/until.
10 Active, On Leave, Retired, etc.
11 Originally designed to be more flexible than what current implementation supports.
12 Multi-valued. Based on US Census Definitions, which in turn are based on OMB standards.
13 Uses InCommon Silver as a reference point.
14 Affiliation could have two levels, eg: student/undergrad.
15 May include both course designator (eg: CS 101) and course role (eg: learner, TA, etc). See also eduCourse / CourseID.
16 May need official vs display (eg: "Professor" vs "Sterling Professor of Rare Earth Elements")
References
- COmanage Registry Data Model
- CPR Data Model (authn required)
- OpenRegistry Data Model
- KIM Data Model ERD
- eduPerson
- IMS Enterprise Information Model and XML Binding
- OpenSocial Social Data 2.5 Draft
- PESC, Core Main Schema v1.12, CEDS -- way too complex?
- SCIM