Entity Semantics

 

RegistryItem Entity

 

 

Structure

 

 

Attribute Name

Attribute Type

Presence

AssignedURN

URNref

Mandatory

CommonName

ShortName

Mandatory

Version

CodeText

 

ObjectLocation

FILEref

 

DefnSource

CodeText

Mandatory

PrimaryClass

CodeText

Mandatory

SubClass

CodeText

 

RelatedType

CodeText

 

MimeType

MIMEtype

Mandatory

RegStatus

CodeText

Mandatory

StatusChg

Datetime

Mandatory

Stability

CodeText

Mandatory

PayStatus

CodeText

Mandatory

ExpiryDate

Date

Mandatory

Description

DescriptionText

Mandatory

SubmittingOrg

ORGANIZATION

Mandatory

ResponsibleOrg

ORGANIZATION

Mandatory

PublicComments

CommentText

 

 

 

Semantic Rules

 

1.      The RegistryItem entity represents the set of all registered objects in the Registry.  Each instance identifies a single registered object. A registry item instance holds only some of the metadata for a registered object; other metadata is held by other entities in the Registry.

 

2.      Each registry item instance is assigned a unique identifier by the Registration Authority (RA). This implicit attribute, herein called RaitemId, is said to be of type REGISTRY_ITEM. It is used to represent relationships of this instance with other information in the Registry.

 

3.      The AssignedURN name is created and assigned by the RA.  It is created to be unique within all OASIS conforming Registry/Repository implementations.  When a Submitting Organization (SO) makes a submission to the Registry, it provides a local reference name of type CodeText.  If possible, the RA uses that name to construct the AssignedURN.

 

4.      The CommonName is provided by the SO.

 

5.      The Version is provided by the SO. It can have an arbitrary format and is used only to help distinguish one registry item from another having the same common name. The AssignedURN will be different for different versions.

 

6.      The ObjectLocation is a URL that identifies the location of the registered object. If the RA is also a repository for the item, then the RA will download the item, store it in the Repository, and create an anonymous FTP locator as a value for ObjectLocation. If the Registry is not also a Repository, then the ObjectLocation is provided by the SO and the RA has no further responsibility. Depending on the value of the PayStatus attribute, the ObjectLocation URL may need to be supplemented with payment or password information before the file containing the object can be retrieved. Some Registries may distinguish themselves by also being the Repository for any free, publicly available objects described in the Registry.

 

7.      The DefnSource takes its value from the DefinitionSource enumeration entity that identifies a collection of accredited Registry/Repository development organizations. If the Registry claims conformance the OASIS Registry/Repository, then the DefnSource is OASIS.

 

8.      The PrimaryClass is provided by the SO and takes its value from the PrimaryClassification enumeration entity. If the DefnSource is OASIS, then PrimaryClass identifies an element of the set {Definition, Instance, Package, Other}.

 

Let G be a registry item whose DefnSource is OASIS.

Case:

 

a)     If the PrimaryClass of G identifies Definition, then the Submitting Organization declares that the registered object identified by G is an xsgml definition object. The SubClass of G will identify the specific kind of definition object it is.

 

b)     If the PrimaryClass of G identifies Instance, then the Submitting Organization declares that the registered object identified by G is an instance of some registered xsgml definition object.  The SubClass of G identifies its type. There must exist a registry item A in the same registry as G satisfying the following conditions: A is the associated item in a uses association with G as the given item, A.PrimaryClass = Definition, A.SubClass = G.SubClass, and A.RegStatus=Registered.

 

c)      If the PrimaryClass of G identifies Package, then the Submitting Organization declares that the registered object identified by G is an OASIS package, subject to the OASIS specific rules for creating, populating, manipulating, and transmitting packages.

 

d)     If the PrimaryClass of G identifies Other, then the Submitting Organization declares that the registered object identified by G is not an OASIS package and has a representation other than as an xsgml definition object or an xsgml instance object.

 

9.      The SubClass is provided by the SO and takes its value from the SubClassification enumeration entity. If the DefnSource is OASIS, then SubClass, if it exists, identifies an element of the set {char-entity-set, rdf-schema, sgml-attribute, sgml-enum-attr-set, sgml-enum-attr-value, sgml-dtd, sgml-element, sgml-param-entity, sox-schema, xdr-schema, xml-attribute, xml-enum-attr-set, xml-enum-attr-value, xml-dtd, xml-element, xml-param-entity, xml-schema}.

 

Let G be a registry item whose DefnSource is OASIS.

Case:

 

a)     If the PrimaryClass of G identifies Definition, then G.SubClass exists and G is a definition object of the identified type.

 

b)     If the PrimaryClass of G identifies Instance, then G.SubClass exists and G is an instance object of the identified type.

 

c)      If the PrimaryClass of G identifies Package or Other, then G.SubClass is undefined.

 

10. The RelatedType is provided by the SO and takes its value from the RelatedDataType enumeration entity.  If the DefnSource is OASIS, then RelatedType, if it exists, identifies an element of the set {reference-manual, user-guide,  white-paper, faq, example, example-set, example-set-information, changelog, readme,  email-discussion-list-information, tool-information, schema-home-page, distribution-home-page, registration-information, other}.

 

Let G be a registry item whose DefnSource is OASIS. If G.RelatedType exists, then there must exist a registry item A in the same registry as G where A is the associated item in a related association with G as the given item.

 

11. The MimeType is provided by the SO.  If G is a registry item whose DefnSource is OASIS, then:

Case:

 

a)     If  the PrimaryClass of G identifies Definition, Instance, or Package, then G.Representation must be a MIME text type.  By default the type is text/xml.

 

b)     If the PrimaryClass of G identifies Other, then G.Representation can be any MIME type.

 

12. The RegStatus is provided by the RA with its value taken from the RegistrationStatus enumeration entity. For OASIS registrations, that entity includes the values {Submitted, Registered, Superseded, Replaced, Withdrawn, Expired}. The StatusChg attribute is the datetime that the RA last approved a change for RegStatus.

 

Let G be a registry item whose DefnSource is OASIS.

Case:

 

a)     If the RegStatus of G identifies Submitted, then G and its associated metadata is not visible to anyone other than the SO and the RA.

 

b)     If the RegStatus of G identifies Registered, then the RA has approved for registration the registered object identified by G. If the RA is also a Repository, then the approval process includes checking the registered object to ensure that it validates as the xsgml item identified by G.PrimaryClass and G.SubClass and that the G.MimeType declaration is appropriate.

 

c)      If the RegStatus of G identifies Superseded, then the RA has received and acted upon a request from the SO that submitted G to supersede it with a new registered object. The original registered object remains available for continued use.

 

d)     If the RegStatus of G identifies Replaced, then the RA has received and acted upon a request from the SO that submitted G to replace it with a new registered object. The original registered object is no longer available, although its metadata will remain in the registry for an indefinite period of time. G.ObjectLocation will now locate the new object.

 

e)     If the RegStatus of G identifies Withdrawn, then the RA has received and acted upon a request from the SO that submitted G to withdraw it. The original registered object is no longer available, although its metadata will remain in the registry for an indefinite period of time. G.ObjectLocation will now have no value.

 

f)        If the RegStatus of G identifies Expired, then G.ExpiryDate has passed with no reaffirmation action from the SO. The original registered object may or may not be available, although the registry item G and other relevant metadata will remain in the registry for an indefinite period of time.

 

13. The Stability attribute is provided by the SO with its value taken from the Stability enumeration entity. For OASIS registrations, that entity includes the values {Static, Dynamic, Compatible}.

 

Let G be a registry item whose DefnSource is OASIS.

Case:

 

a)     If the Stability of G identifies Static, then the SO declares that the registered object identified by G will not be replaced or withdrawn before the ExpiryDate. It is the responsibility of the RA to ensure as best it can that this declaration is not violated.

 

b)     If the stability of G identifies Dynamic, then the SO declares that the registered object identified by G may change without notice, possibly in incompatible ways.

 

c)      If the stability of G identifies Compatible, then the SO declares that the registered object defined by G will not be replaced with an incompatible object. If the registerd object is a DTD, then new element and attribute declarations may be added to the DTD, but a document that validates to the original DTD will also validate to its replacement. The notion of compatibility needs to be examined for all xsgml definition and instance objects and for OASIS packages!

 

14. The PayStatus attribute is provided by the SO with its value taken from the Payment_Status enumeration entity. For OASIS registrations, that entity includes the values {Free, Password, Debit}. It is expected that these options will expand as online payment alternatives become standardized.

 

Let G be a registry item whose DefnSource is OASIS.

Case:

 

a)     If the PayStatus of G identifies Free, then the URL of G.ObjectLocation follows an anonymous protocol that allows retrieval of the registered object with no password or payment obstructions.

 

b)     If the PayStatus of G identifies Password, then access to the object is free, but a password is required. The procedure for obtaining a password is not part of this specification.

 

c)      If the PayStatus of G identifies Debit, then it is possible to purchase the registered item on-line and then download it using the URL of G.ObjectLocation. The procedure for handling the debit or credit card transaction is not part of this specification.

 

15. The ExpiryDate is assigned by the RA upon suggestion from the SO. Some RA's may follow very definite procedures for the length of time an object can remain registered before an affirmation or withdrawal action is required.  If the Expiration date passes without an SO action, then the RA initiates an expiration action.

 

16. The Description is provided by the SO.

 

17. The SubmittingOrg identifies the organization submitting the registered object. It points to a unique instance of the ORGANIZATION entity. On presentation of this information, the RA substitutes the CommonName of the organization. The SO must be known to the RA before it can make submissions to the Registry/Repository, and they each know of a unique URN for the other. The process for becoming known is not part of this specification.

 

18. The ResponsibleOrg identifies the organization responsible for the formal specification of the registered object. It points to a unique instance of the ORGANIZATION entity. The RO may be a formal accredited standards development organization or it may be the SO. On presentation of this information, the RA substitutes the OrgURN of the organization.

 

19. The PublicComment may be suggested by the SO, but it is supplied by the RA.  In most cases the comment will explain some administrative process that cannot be clearly determined from the standardized information.  For example, this comment may explain how long the metadata for a replaced or withdrawn object remains available, or how long an expired object remains available before it is deleted.


Association Entity

 

 

Structure

 

 

Attribute Name

Attribute Type

Presence

GivenItemRole

CodeText

Mandatory

AssocItemURN

URNref

Mandatory

AssocItemId

REGISTRY_ITEM

 

Comment

CommentText

 

 

 

Semantic Rules

 

1.      The Association entity represents a many-to-many relationship from the RegistryItem entity to itself. Each association instance relates a given registry item instance to an associated registry item instance. The given item plays a specified role with the associated item.

 

2.      Each instance of an Association depends upon the given item. This dependency is represented by an implicit value, GivenItemId, of type REGISTRY_ITEM.

 

3.      The GivenItemRole is provided by the SO with its value taken from the AssociationType  enumeration entity.  For OASIS registrations, that entity includes the values {Uses, Supersedes, Contains, Related}.

 

4.      The AssocItemURN is provided by the SO.  It must identify the AssignedURN of some registry item in some OASIS conformant Registry.  If the Registry is not the local one, then the RA has no responsibility to ensure that it identifies a relevant item.

 

5.      The AssocItemId is present if and only if the registry item identified by the AssocItemURN is a registry item in the same registry as the association instance. In that situation, AssocItemURN and AssocItemId identify the same registry item.

 

6.      Let G be a registry item whose DefnSource is OASIS and let X be an association instance linked to G with G as the GivenItem.

 

Case:

 

a)     If X.GivenItemRole identifies Uses, then the SO declares that G uses the registry item identified by X.AssocItemURN. The RA is under no obligation to check whether this declaration is or remains true.

 

b)     If X.GivenItemRole identifies Supersedes, then the SO declares that G supersedes the registry item identified by X.AssocItemURN. If A is that item, then A must be in the same registry as G and A.RegStatus must be Superseded.

 

c)      If X.GivenItemRole identifies Contains, then the SO declares that G contains the registry item identified by X.AssocItemURN. If A is that registry item, then A must be in the same registry as G and A.PrimaryClass must be Package.

 

d)     If X.GivenItemRole is Related, then the SO declares that G is related data for the registry item identified by X.AssocItemURN. The RA is under no obligation to check whether this declaration is or remains true.

 

7.      The Comment is provided by the SO.  It may explain in more detail the relationship between the given and associated registry items.

 

 

 


RelatedData Entity

 

 

Structure

 

 

AttributeName

AttributeType

Presence

DataName

ShortName

Mandatory

DataLocation

URLref

Mandatory

RelatedType

CodeText

Mandatory

MimeType

MIMEtype

 

Comment

CommentText

 

                                   

 

 

Semantic Rules

 

1.      The RelatedData entity represents the set of non-registered objects that are related to registered objects. Each instance is a pairwise relationship between a single registered item and a single related data item. A registered item may map to many related data items.

 

2.      Each instance of  RelatedData depends upon a RegistryItem instance. This dependency is represented by an implicit value, RAitemId, of type REGISTRY_ITEM.

 

3.      The DataName attribute is provided by the SO. It is intended that this be the link name for the DataLocation if related data items are presented visually to a user.

 

4.      The DataLocation is provided by the SO. This link is not under the control of the RA and it may point anywhere.  The RA is under no obligation to ensure that the link is a valid one.

 

5.      The RelatedType is provided by the SO and takes its value from the RelatedDataType enumeration entity. It may include values not defined by OASIS.

 

6.      The MimeType is provided by the SO.  It identifies the MIME type of the related data item. The RA is under no obligation to ensure that the declared MimeType type is consistent with the actual file type of the file referenced by DataLocation.

 

7.      The Comment is provided by the SO.  It may further explain the relationship between the related data instance and the registry item it is linked to.

 


Classification Entity

 

 

Structure

 

 

AttributeName

AttributeType

Presence

SchemeURN

URNref

Mandatory

LevelCode

CodeText

Mandatory

ItemValue

CodeText

Mandatory

Comment

CommentText

 

 

 

Semantic Rules

 

1.      The Classification entity identifies all classifications of a registry item.

 

2.      Each Classification instance identifies a node in a classification hierarchy and maps the registry item to that node.

 

3.      Each Classification instance has an implicit value, RAitemId, of type REGISTRY_ITEM that maps that instance to its associated registry item. The classification instance is dependent on that registry item.

 

4.      The SchemeURN is provided by the SO.  It must identify the AssignedURN of some  registry item in the same Registry as the classification instance and the object referenced by that registry item must be a classification scheme.

 

5.      The LevelCode is provided by the SO, or the RA fills it in by default, depending on the type of classification scheme identified by the SchemeURN. If that classification scheme does not require multiple levels, then the default value for LevelCode is “leaf”.

 

6.      The ItemValue attribute is provided by the SO. It must be a legal ItemValue as defined by the registered classification scheme.

 

7.      The optional Comment is supplied by the SO. It might give a purpose for using the identified classification scheme, or explain why multiple values are given for the same level, or qualify the classification in some other way.


Organization Entity

 

 

Structure

 

AttributeName

AttributeType

Presence

OrgURN

URNref

Mandatory

OrgFullName

LongName

Mandatory

CommonName

ShortName

 

OrgURL

URLref

 

ParentOrg

ORGANIZATION

 

AddrLine1

AddrLineText

 

AddrLine2

AddrLineText

 

AddrLine3

AddrLineText

 

City

ShortName

 

StateProv

ShortName

 

Country

ShortName

Mandatory

PostalCode

CodeText

 

Email

EmailText

 

Telephone

TelephoneText

 

Fax

TelephoneText

 

Comment

CommentText

 

 

 

Semantic Rules

 

1.      The Organization entity represents the set of all companies and organizations known to a Registry.  Each instance represents a single organization or company.  If an organization is part of another organization, or if a company is a sub-unit of another company, then the organization is linked to its parent.

 

2.      Each Organization instance is represented by an identifier of type ORGANIZATION. This identity is used to link an organization with other entities in the Registry.

 

3.      Each organization instance has a relationship with one or more Contact instances.

 

4.      The OrgURN is assigned by the Registration Authority (RA).  It most cases it will be a natural construction derived from the CommonName of the company.

 

5.      The OrgFullName is provided by the Submitting Organization (SO) or by the Responsible Organization (RO). It is intended to be the full legal name of the organization in the home country of its existence. The OrgFullName and Country values together uniquely determine an organization instance.

 

6.      The CommonName is provided by the SO. It is the name or symbol that is used in common discourse to identify the company or organization.

 

7.      The OrgURL is provided by the SO. It is the locator for the home page of that company or organization on the world wide web.

 

8.      The ParentOrg is provided by the SO or the RA.  If the company or organization is a subsidiary of a company already listed in this entity, then ParentOrg is the identifier of the parent organization.  If the organization has no known parent, then this attribute is null.

 

9.      The three AddressLine attributes identify the street or post office address of the company or organization.  AddressLines that are not needed are set to null. They are provided by the SO.

 

10. The City is provided by the SO.  It identifies the city associated with the AddressLines.

 

11. The StateProv is provided by the SO.  It identifies the state, province, territory, or other political unit between the city and country.

 

12. The Country is provided by the SO.  It identifies the home country of the company or organization.

 

13. The PostalCode is provided by the SO.  Together with the street address, city, and country, it is the mailing address of the company or organization headquarters.

 

14. The Email is provided by the SO.  It identifies the best email address to use when trying to reach the company or organization headquarters.

 

15. The Telephone attribute is provided by the SO. It identifies the best international telephone number to use when trying to reach the company or organization headquarters.

 

16. The Fax attribute is provided by the SO. It identifies the best international facsimile telephone number to use when trying to reach the company or organization headquarters.

 

17. The Comment is provided by the SO or RA. It conveys any important information not captured by the other attributes.

 

 


Contact Entity

 

 

Structure

 

AttributeName

AttributeType

Presence

ContactName

ShortName

Mandatory

OrgId

ORGANIZATION

Mandatory

OrgRole

CodeText

Mandatory

SubmitId

SUBMISSION

 

ReguestNbr

SmallInt

 

Availability

CodeText

Mandatory

ContactRole

CodeText

Mandatory

Email

EmailText

 

Telephone

TelephoneText

 

Fax

TelephoneText

 

Comment

CommentText

 

 

 

Semantic Rules

 

1)     The Contact entity identifies all of the contacts known to the Registry.  A Contact instance is a single contact.  A contact may be a person, a company office, or a job title that can respond to Registry related issues.

 

2)     Each Contact instance is represented by an identifier of type CONTACT. This identity is used to link a contact with other entities in the Registry.

 

3)     Each contact instance is linked to a single organization.

 

4)     The ContactName is provided by the SO. It identifies a person or office associated with the SO able to speak to technical or administrative questions about registered objects. The name need not be globally unique, but it is intended that it be recognized by whoever may answer the telephone number provided in this instance.

 

5)     The OrgId is provided by the RA. It is derived from the OrgURN provided by the SO as part of a submission or request.

 

6)     The OrgRole is provided by the SO, with its value taken from the OrganizationRole enumeration entity.  For OASIS registrations, that entity identifies one of the values {SO, RA, RO}.

 

7)     The SubmitId is provided by the RA. If this contact was provided as part of a submission from the SO to the RA, then it references that submission.

 

8)     The RequestNbr is provided by the RA. If this contact was provided as part of a request in a submission from the SO to the RA, then it references that request.

 

9)     The Availability code is provided by the SO with its value taken from the ContactAvailability enumeration entity.  For OASIS registrations, that entity indentifies one of the values {Private, Protected, Public}.  The default value is Public.

 

If the Availability value is:

Case:

a)     Private, then the RA will not reveal the <simple-contact> to  any other organization.

 

b)     Protected, then the RA may reveal the <simple-contact> to other legitimate registration authorities.  [Note: legitimate left purposely undefined for now.]

 

c)      Public, then the RA may reveal the <simple-contact> to any user of the registry maintained by the RA.

 

10) The ContactRole is provided by the SO with its value taken from the ContactRole  enumeration entity.  For OASIS registrations, that entity identifies one of the values {Administrative, Technical, All Issues}.  The default value is All Issues.

 

If the ContactRole value is:

Case:

a)     Administrative, then the contact is prepared to address administrative questions related to registered items.

 

b)     Technical, then the contact is prepared to address technical questions related to registered items.

 

c)      All Issues, then the contact is prepared to address all issues related to the submitted item.

 

11) The Email address is provided by the SO. It is a global email address that is the best address to use when trying to contact someone who can respond to issues involving registered items.

 

12) The Telephone number is provided by the SO. It is a single international telephone number, possibly with an extension, that is the best number to use when trying to contact a person who can speak to issues involving registered items.

 

13) The Fax number is provided by the SO. It is the best facsimile telephone number to use when trying to contact a person who can speak to issues involving registered items.

 

14) The Comment is provided by the SO. It  explains in natural language the relationship of the contact to the item or items submitted for registration. It may explain further the role of the contact.


AlternateName Entity

 

Structure

 

 

AttributeName

AttributeType

Presence

AltName

LongName

Mandatory

Context

CodeText

Mandatory

Comment

CommentText

 

Language

CodeText

 

Encoding

CodeText

 

 

 

Semantic Rules

 

1.      The AlternateName entity is the set of alternate names that are associated with registered objects.  Each instance gives the alternate name, its language and encoding, and its context.

 

2.      Each AlternateName instance has an implicit value, RAitemId, of type REGISTRY_ITEM that maps that instance to its associated registry item. The alternate name instance is dependent on that registry item.

 

3.      The AltName attributes is provided by the SO.

 

4.      The Context is provided by the SO.  It is a code value that identifies an item from the NameContext enumeration entity. The context may identify the name as a URN from some other registry, or identify the name as appropriate for use with a specific programming language, or provide a name for the registered object in some other human language.

 

5.      The Comment is provided by the SO. It may give further details about how the name should be used.

 

6.      The Language attribute is provided by the SO. It is of datatype LanguageId, defined in Section 6.4. The default is "en-US".

 

7.      The Encoding attribute is provided by the SO. It is of datatype Encoding, defined in Section 6.4. The default is "Latin-1".

 

8.      The intent is that all attribute values for an AlternateName instance be encoded in the encoding scheme identified by the Encoding attribute.

 

 


AlternateDescription Entity

 

Structure

 

 

AttributeName

AttributeType

Presence

Language

CodeText

Mandatory

Encoding

CodeText

Mandatory

Description

DescriptionText

Mandatory

 

 

Semantic Rules

 

1.      The AlternateDescription entity is a set of  descriptions in various human languages that are associated with  registered objects.  Each instance is a single description associated with a single registry item, with the human language and character encoding identified. The intent is that each description is a direct translation of the Description attribute of the associated registry item into the language and encoding identified by the Language and Encoding attributes.

 

2.      Each AlternateDescription instance has an implicit value, RAitemId, of type REGISTRY_ITEM that maps that instance to its associated registry item. The alternate description instance is dependent on that registry item.

 

3.      The Language attribute is provided by the SO. It is of datatype LanguageId, defined in Section  The default is "en-US".

 

4.      The Encoding attribute is provided by the SO. It is of datatype Encoding, defined in Section 6.4. The default is "Latin-1".

 

5.      The Description is provided by the SO. The intent is that each description is a direct translation of the Description attribute of the associated registry item into the language and encoding identified by the Language and Encoding attributes.

 

 


Submission Entity

 

Structure

 

 

AttributeName

AttributeType

Presence

SubmitTime

Datetime

Mandatory

SubmitOrg

ORGANIZATION

Mandatory

Comment

CommentText

 

 

 

Semantic Rules

 

1.      The Submission entity represents a set of submissions made to a Registration Authority (RA) from a Submitting Organization (SO). The RA will keep a record of all submissions for an indefinite period of time determined by some higher authority.

 

2.      Each instance of the Submission entity represents a single submission. If the SO is not known to the RA, then the Submission must consist of a single request, CertifySO, that asks the RA to certify the submitter as an SO for that Registry.

 

3.      Each Submission instance is represented by an identifier of type SUBMISSION. This identifier is locally determined by the RA, but will often be a timestamp.

 

4.      A submission must be related to one or more contacts. Each contact is represented as an instance of the Contact entity.

 

5.      A submission must be related to one or more requests. Each request is represented as an instance of the Request entity.

 

6.      The SubmitTime attribute is provided by the RA. It identifies the time, with precision to the minute or finer, that the submission was first received. In many cases this attribute will just be a truncation of the more accurate timestamp used for the submission identifier.

 

7.      The SubmitOrg attribute identifies the Submitting Organization. If this is not a submission requesting certification of a company or an organization as a new SO, then the submitting organization must be previously known to the RA. The SO and RA will identify themselves to one another by using their respective OrgURN's.

 

8.      The Comment attribute is provided by the SO. It may describe the purpose of the submission or give a human readable introduction to the containing requests.


Request Entity

 

Structure

 

 

AttributeName

AttributeType

Presence

RequestNbr

SmallInt

Mandatory

RequestCode

CodeText

Mandatory

ContentXML

XMLtext

Mandatory

Comment

CommentText

 

 

 

Semantic Rules

 

1.      The Request entity represents a set of requests made to a Registration Authority (RA) from Submitting Organizations (SO).

 

2.      Each Request instance must be received by the RA as part of a submission package. Each Request instance has an implicit value, SubmitId, of type SUBMISSION that identifies the submission package.

 

3.      Each submission may consist of multiple requests.  The RequestNbr attribute is a positive integer provided by the RA to distinguish among multiple requests in the same submission.  In most cases, if there are N requests in a submission package, then the RequestNbr's will vary from 1 to N inclusive. This default may be overridden by the SO, but there is no semantic significance to request order.

 

4.      The RequestCode attribute is provided by the RA after receiving an XML Request DTD from an SO. Its value is the code defined by the RegistryRequest enumeration entity. It may include values not defined by OASIS.

 

5.      The ContentXML attribute is provided by the SO.  It is the exact XML Request element provided by the SO as part of a submission package. The RA will keep a record of all such requests for an indefinite period of time determined by some higher authority.

 

6.      The Comment attribute is provided by the SO. It may provide further explanation about the purpose of the request.


Impact Entity

 

Structure

 

 

AttributeName

AttributeType

Presence

SubmitId

SUBMISSION

Mandatory

RequestNbr

SmallInt

Mandatory

RAitemId

REGISTRY_ITEM

Mandatory

ImpactCode

CodeText

Mandatory

Comment

CommentText

 

 

 

Semantic Rules

 

1.      The Impact entity represents a many-to-many relationship between the Request entity and the RegistryItem entity. Each Impact instance relates a single Request instance with a single RegistryItem instance

 

2.      A request, e.g. CertifySO, may not have an impact on any registry item, whereas other requests, e.g. AddAssociation, will have an impact on both the given and associated items. Thus the need for a many-to-many mapping

 

3.      The Impact entity, together with its parent Submission and Request entities, will maintain a historical record of all SO-initiated modifications of a registry item from first creation to final deletion.

 

4.      Every registry item must derive from at least one request, e.g. the request that created it. But it can be impacted by many subsequent requests, e.g. a sequence of updates over time.

 

5.      The SubmitId and RequestNbr attributes are provided by the RA. They identify the submission package and the request that had an impact on the related registry item.

 

6.      The RAitemId attribute is provided by the RA.  It identifies the impacted registry item.

 

7.      The ImpactCode attribute is provided by the RA.  This code identifies one of the impacts specified by the RegistryItemImpact entity domain.

 

8.      The Comment is provided by the RA.  It may explain some unusual consideration.


ClassificationScheme Entity

 

 

Structure

 

 

AttributeName

AttributeType

Presence

SchemeURN

URNref

Mandatory

Comment

CommentText

 

 

 

Semantic Rules

 

1.      The ClassificationScheme entity identifies the classification schemes known to a Registry.  Each instance of this entity identifies one classification scheme.

 

2.      Each instance of a ClassificationScheme is in a one-to-one correspondence with an instance of the RegistryItem entity.  This dependency is represented by an implicit value, RaitemId, of type REGISTRY_ITEM.

 

3.      The SchemeURN matches the AssignedURN of the associated registry item.

 

4.      The Comment is provided by the SO. It may expand upon the Description provided by the Description attribute of the associated registry item.


ClassificationLevel Entity

 

Structure

 

 

AttributeName

AttributeType

Presence

LevelCode

CodeText

Mandatory

LevelNbr

SmallInt

Mandatory

LevelName

LongName

 

Comment

CommentText

 

 

 

Semantic Rules

 

1.      The ClassificationLevel entity identifies the levels of a classification scheme. Each instance represents a single level of the scheme.

 

2.      Each instance of a ClassificationLevel depends upon a ClassificationScheme instance.  This dependency is represented by the implicit value, SchemeId, of type REGISTRY_ITEM. If the classification scheme is a simple 1-level scheme, then the scheme has a single default level instance with LevelNbr set equal to 1, LevelName = "Level 1", and LevelCode = "1".  The SO can override these defaults.

 

3.      The LevelCode is provided by the SO. It identifies the value that will be referenced as the level code in a Classification.

 

4.      The LevelNbr is provided by default by the RA if not explicitly provided by the SO.  It is a positive integer that identifies the level in a classification hierarchy.  In most cases, if there are N levels, then the LevelNbr's vary from 1 to N inclusive. The SO may override these defaults by explicitly numbering the levels provided in an XML ClassificationScheme DTD.

 

5.      The optional LevelName, if present, is provided by the SO. It may be a longer descriptive name that more completely identifies the level.  The LevelName is never used in a Classification; instead, the LevelCode is always used.

 

6.      The Comment is provided by the SO. It may further describe the level.


ClassificationItem Entity

 

Structure

 

 

AttributeName

AttributeType

Presence

ItemId

SmallInt

Mandatory

ItemValue

CodeText

Mandatory

ItemName

LongName

 

ParentId

SmallInt

Mandatory

Comment

CommentText

 

 

 

Semantic Rules

 

1.      The ClassificationItem entity represents the classification hierarchy of a classification scheme. Each instance represents a node in that hierarchy. For convenience, we define a node to represent the entire sub-tree below it.  The term item is used to reference an individual node without the sub-tree below it.

 

2.      Each instance of a ClassificationItem depends upon a ClassificationScheme instance and a ClassificationLevel instance.  This dependency can be represented by a pair of typed values: SchemeId of type CLASSIFICATION_SCHEME, and LevelNbr of type SmallInt. If the classification scheme is a simple 1-level scheme, then all nodes map to the single default level having LevelNbr=1.

 

3.      The ItemId attribute is a positive integer that identifies each node of the classification hierarchy. The Item Id's are provided locally by the RA, usually numbered consecutively based on an instance of a node in the XML ClassificationScheme DTD.  The root of each classification hierarchy is the classification scheme itself. The root is a virtual node, not represented in this entity, that is assumed to have ItemId=0.

 

4.      The ItemValue is provided by the SO. It identifies the value that will be referenced as the item value in a Classification.

 

5.      The optional ItemName, if present, is provided by the SO. It may be a longer descriptive name that more completely identifies the item.  The ItemName is never used in a Classification; instead, the ItemValue is always used.

 

6.      The ParentId is supplied by the RA. It references the ItemId of the parent node in the classification hierarchy.  If the node is at Level 1 in the classification hierarchy, then the ParentId is set to 0, to indicate that its parent node is the virtual root of the hierarchy.

 

7.      The Comment is provided by the SO. It may further describe the item.


Repository Entity

 

Structure

 

 

AttributeName

AttributeType

Presence

 

 

 

INCOMPLETE

 

 

 

 

 

 

 

 

 

 

 

 

 

Semantic Rules

 

[TO BE COMPLETED]