Taxonomy Overview Document

Name of the Value Set

 

Location:

[Provide the URL to this document. Suggested file name convention: "valueset-xxx-200ymmdd" - where xxx represents the taxonomy name. Filenames SHOULD use all lower case.]

Author:

[List your authors here]

Editors:

[As applicable, list your editors here]

Abstract:

[Supply a summary of the purpose of the value set in one or two paragraphs.]

Conformance

[As applicable] This document conforms to the UDDI Technical Committee “Value Set Overview Documents” Technical Note (http://www.oasis-open.org/committees/uddi-spec/doc/tn/uddi-spec-tc-valueset-overviewdocument-template20040316.htm)

1 Application of the value set

[Provide a brief introduction discussing the purpose of the value set, and where and how it can be applied.]

[Optionally, list possible applications and field of use, e.g. where the value set is considered to add value to the discovery process.]

[Optionally, specify any special circumstances when use of the value set is not recommended.]

2 tModel definition

[Insert values from your tModel definition to fill in the table. See http://uddi.org/tmodels.html for more information on registering tModels.]

tModel Name  
tModel Description  
Overview Document URL  
v2 tModel Key  
v3 tModel Key  
Categorization  
Checked/Un-checked  

3 tModel structure

[Include the full tModel structure in XML as in this example

<tModel tModelKey="uuid:C0B9FE13-179F-413D-8A5B-5004DB8E5BB2">
    <name>ntis-gov:naics:1997</name>
    <description xml:lang="en">Business Taxonomy: NAICS (1997 Release)</description>
    <overviewDoc>
        <description xml:lang="en">This tModel defines the NAICS industry taxonomy.</description>
        <overviewURL>http://www.uddi.org/taxonomies/UDDI_Taxonomy_tModels.htm#NAICS</overviewURL>
    </overviewDoc>
    <categoryBag>
        <keyedReference tModelKey="uuid:C1ACF26D-9672-4404-9D70-39B756E62AB4"
                keyName="types"
                keyValue="categorization"/>
        <keyedReference tModelKey="uuid:C1ACF26D-9672-4404-9D70-39B756E62AB4"
                keyName="types"
                keyValue="checked"/>
    </categoryBag>
</tModel>

]

4 Valid values

[List and describe the values in the table below]

Name Value Description
     
     
     

[Alternatively, specify a URL to an external resource with the values or explain how the values can be computed.]

5 Validation

[Remove this section if no validation is provided.]

5.1 Supported validation capabilities

[Provide a general description of the validation capabilities]

5.2 Validation APIs

[Describe the API or provide a URL to an external resource]

5.3 Caching of valid values

[Provide caching rules]

6 Versioning

[Provide information on the versioning rules for the value set.]

[Remove the following statement if the value set versioning does not conform to the TN]

The value set conforms to the Versioning Value Sets in a UDDI Registry, Version 1.12, OASIS UDDI Spec TC Technical Note, http://www.oasis-open.org/committees/uddi-spec/doc/tn/uddi-spec-tc-tn-versioning-value-sets.htm.

[Provide a list of all supported versions in the table below]

Version Key Valid from/to Status Comments
         
         
         

7 Structure

[In this section you should provide a brief overview of the structure of the value set, e.g. if it is a set of disparate values or forms a hierarchy, network, clusters, etc. Describe any special structure inherent in the actual values themselves, e.g. partitioned values such as UDDI keys, URNs, etc.]

[Explain the relationship mechanism, e.g. what XML attributes are used as IDs or pointers; or provide a plain language description or a diagram of the relationships between the elements (values).]

8 Examples

[Provide at least one example of use of the value set. The example SHOULD be an XML excerpt illustrating the use of <categoryBag> or <identifierBag> with values from the value set.]

[Replace the following with your example]

<tModel tModelKey=...

    ...

    <categoryBag>

    <!--Specify that this is a taxonomy tModel by classifying it as "categorization"

            under the uddi-org:types taxonomy -->

    <keyedReference

        keyName="uddi-org:types"

        keyValue="categorization"

        tModelKey="uuid:C1ACF26D-9672-4404-9D70-39B756E62AB4"/>

    <keyedReference

        keyName="uddi-org:types"

        keyValue="checked"

        tModelKey="uuid:C1ACF26D-9672-4404-9D70-39B756E62AB4"/>

    </categoryBag>

    ...

</tModel>

[Illustrate how one efficiently makes queries using this value set. This SHOULD include how best to leverage the use of approximateMatch behavior in V3 registries.]

9 How to obtain the value set and related information

The value set is available at [http://replace.with.your.url/]. Additional resources are listed in the table below:

Resource name URL Format Comment
       
       
       

[Remove or modify as applicable]

Access to the value set requires [PAYMENT/REGISTRATION/LEGAL AGREEMENT]. More information on the Terms and Conditions is available [http://replace.with.your.url/].

10 Intellectual Property Rights

[As applicable] The value set is under [COPYRIGHT]. Our full copyright statement is available at [http://replace.with.your.url/]. Resources required for the application of the value set have the following Property Rights Restrictions:

Resource name URL IP claims, copyright and licensing More info (URL)
       
       
       

11 Additional information

[If needed, provide any additional information that may assist the access, understanding and application of the value set.]