Department of Defense (DoD) Metadata Registry and Clearinghouse
XML Registry User’s Manual (UM)
30 January 2004
Prepared for: Defense Information Systems Agency
Prepared by: FGM Inc. 45245 Business Court, Suite 400 Dulles, VA 20166
Table of Contents
i
30 January 2004
Table of Contents
Overview ..................................................................................................................................... 1 1.1 Purpose .................................................................................................................................... 1 1.2 Document Conventions .......................................................................................................... 2 2. Registration and Log In ............................................................................................................. 3 2.1 Registering as a New User ..................................................................................................... 3 2.2 Logging into the XML Registry ............................................................................................ 5 2.3 Updating Existing Registration Information ......................................................................... 7 2.4 Resetting Your Password ..................................................................................................... 10 3. Navigating the XML Registry ................................................................................................. 12 3.1 Navigation Bar ...................................................................................................................... 12 3.2 Links on the XML Registry Home Page ............................................................................. 13 4. Namespaces .............................................................................................................................. 15 4.1 Viewing Namespace Information ........................................................................................ 15 4.1.1 Viewing Information About the Namespace Manager ................................................ 16 4.1.2 E-mailing the Namespace Manager .............................................................................. 16 4.1.3 Viewing the Namespace Business Rules ...................................................................... 16 4.2 Listing Namespaces and Their IRs ...................................................................................... 16 4.3 Viewing the Available IRs ................................................................................................... 18 5. Searching the XML Registry ................................................................................................... 20 5.1 Using the Simple Search ...................................................................................................... 20 5.2 Using the Advanced Search ................................................................................................. 21 5.3 Searching Package Documents ............................................................................................ 22 6. Reports ...................................................................................................................................... 24 6.1 Similar Information Resources ............................................................................................ 24 7. Subscriptions ............................................................................................................................ 25 7.1 Viewing Your Subscriptions ................................................................................................ 25 7.2 Subscribing to a Package...................................................................................................... 25 7.3 Subscribing to IRs in a Package .......................................................................................... 26 7.4 Modifying a Subscription’s Interest Level or Notification Type ...................................... 27 7.5 Unsubscribing to All IRs ...................................................................................................... 27 7.6 Unsubscribing to Specific IRs ............................................................................................. 27 8. Changed IRs ............................................................................................................................. 28 9. The Briefcase ............................................................................................................................ 29 9.1 Adding an Information Resource to the Briefcase ............................................................. 29 9.2 Viewing the Briefcase’s Contents ....................................................................................... 29 9.3 Removing a Single Information Resource from the Briefcase .......................................... 30 9.4 Removing All Information Resources from the Briefcase ................................................. 30 9.5 Downloading the Information Resources in the Briefcase ................................................ 30 9.6 Creating a Schema from the Information Resources in the Briefcase............................... 30 10. Submission Packages ............................................................................................................... 33 10.1 Creating Submission Packages ......................................................................................... 33 10.1.1 Creating Information Resources ................................................................................ 33 10.1.2 Creating the Manifest.xml File .................................................................................. 34 10.1.3 Registry Validation Rules .......................................................................................... 34 1.
i
30 January 2004
10.2 Validating and Submitting Packages................................................................................ 35 10.3 Creating and Converting Packages................................................................................... 35 11. Registered Systems .................................................................................................................. 39 11.1 Viewing Registered Systems ............................................................................................ 39 11.1.1 Viewing Registered Systems ..................................................................................... 39 11.1.2 Viewing a Registered Systems Point of Contact ...................................................... 39 11.2 Requesting New System User Registration ..................................................................... 39 12. Feedback and Comments ......................................................................................................... 40 Appendix A – Information Resources .............................................................................................A-1 What is an Information Resource? ...............................................................................................A-1 Information Resource Relationships Within the XML Registry ................................................A-2 Element and Attribute Data Types Supported by the XML Registry ........................................A-3
ii
30 January 2004
List of Tables
Table 1. Table 2. Table 3. Table 2. Table 3. Table 4. Table 5. Table 6. Document conventions ......................................................................................................... 2 XML Registry Navigation Bar Options............................................................................. 12 XML Registry Home Page Links....................................................................................... 13 Supported Information Resource Types ..........................................................................A-1 Relationships Supported by the XML Registry ..............................................................A-2 Element/Attribute Data Types..........................................................................................A-4 XML Schema Document (XSD) Simple Data Types .....................................................A-4 XML Schema Document (XSD) Data Type Facets........................................................A-5
iii
30 January 2004
List of Figures
Figure 1. XML Registry Login page .................................................................................................. 3 Figure 2. Registration Form ................................................................................................................ 4 Figure 3. Sample registration confirmation page .............................................................................. 5 Figure 4. XML Registry Login page .................................................................................................. 6 Figure 5. Security Alert window ........................................................................................................ 6 Figure 6. XML Registry Home page when logged in ....................................................................... 7 Figure 7. Sample registration update form ......................................................................................... 9 Figure 8. Password Request Form .................................................................................................... 10 Figure 9. Sample Namespace Information page .............................................................................. 15 Figure 10. Namespace list and inventory link ................................................................................. 16 Figure 11. Current Inventory page ................................................................................................... 17 Figure 12. Search Results page ......................................................................................................... 18 Figure 13. Current Inventory page ................................................................................................... 19 Figure 14. Simple search page .......................................................................................................... 20 Figure 15. Advanced search page ..................................................................................................... 21 Figure 16. Search Package Documents page ................................................................................... 23 Figure 17. Sample Briefcase Contents page .................................................................................... 29 Figure 18. Create Schema from Briefcase page .............................................................................. 31 Figure 19. Sample schema file .......................................................................................................... 32 Figure 20. Sample submission package ........................................................................................... 33 Figure 21. Submission Package Creation and Conversion Tool .................................................... 36 Figure 22. Submission Package Creation/Conversion Tool form .................................................. 37 Figure 23. The Feedback and Comments Page................................................................................ 40
iv
30 January 2004
This page intentionally left blank.
30 January 2004
1. Overview
Defense Information Systems Agency (DISA) is responsible for data services and other datarelated infrastructures that promote interoperability and software reuse in the secure, reliable, and networked environment planned for the DoD's Global Information Grid (GIG). The Metadata Registry and Clearinghouse's primary objective is to provide software developers access to data technologies to support DoD mission applications. Through the Metadata Registry and Clearinghouse, software developers can access registered eXtensible Markup Language (XML) data and metadata components, COE database segments, and reference data tables and related meta-data information such as Country Code and US State Code. These data technologies increase the DoD's core capabilities by integrating common data, packaging database servers, implementing transformation media and using Enterprise data services built from "plug-andplay" components and data access components. The XML Registry is just one of the registries of the Metadata Registry and Clearinghouse. eXtensible Markup Language (XML) is a platform and vendor independent data interchange format. XML provides self-describing text in the form of Information Resources (IRs) such as submission packages, elements, attributes, and schemas. For additional information on IRs, please see Appendix A – Information Resources. XML can handle data, data structures, and the description of the data (metadata). The following is an example of the XML syntax:
The Round Door Tom Evans 1996 0-9546-0274-3 $23.00 An intriguing tale of a round door in a wall
1.1 Purpose
This document provides information for using the XML Registry. This information includes: Registering and logging in Searching the XML Registry Viewing namespaces and information resources within the namespace Working with subscriptions Using the briefcase
1
30 January 2004
1.2 Document Conventions
The following conventions are used in this document: Table 1. Document conventions Bold Indicates the names of pages, buttons, fields, menu options, and links will be in bold text. For example, click the OK button. Keyboard names, such as [ENTER] and [TAB] are enclosed within brackets. Shortcuts for menu selections are connected with angle brackets (>). For example, the instruction “From the File menu, select Print. Then select Input Detail.” would be written as Select the File > Print > Input Detail menu option. Italics The name of an option from a drop-down list and radio buttons. For example, select Active from the Status dropdown list. Notes, tips, and other critical information are contained in text boxes. For example:
NOTE: The Name, Latitude, and Longitude fields are required.
[Brackets] Angle Brackets (>)
Text boxes
2
30 January 2004
2. Registration and Log In
The DoD requires that all users of the Metadata Registry and Clearinghouse register with the registry administrator before they can use the site.
2.1 Registering as a New User
To register as a new user: 1. Open a web browser and enter the following URL:
http://diides.ncr.disa.mil/xmlreg/user/index.cfm
2. From the XML Registry home page, click the Login link. The XML Registry Login page displays.
Figure 1. XML Registry Login page 3. Click the Click Here link. The Registration Form displays.
3
30 January 2004
Figure 2. Registration Form
4
30 January 2004
4. Enter the information requested in the form. At a minimum, you must provide information for the fields marked with an asterisk (*). 5. To submit the information, click the Register button. To clear the form and re-enter the information, click the Clear Form button. If you provided all the required information and clicked the Register button, the registration confirmation page displays.
Figure 3. Sample registration confirmation page
2.2 Logging into the XML Registry
1. Open a web browser and enter the following URL:
http://diides.ncr.disa.mil/xmlreg/user/index.cfm
2. From the XML Registry home page, click the Login link. The XML Registry Login page displays.
5
30 January 2004
Figure 4. XML Registry Login page 3. If you have not registered with the Metadata Registry, please refer to section 2.1, Registering as a New User. Otherwise, enter your user ID and password. NOTE: If you have forgotten your password, click on the Forgot your password link and see section 2.4 for more information. 4. Click the Login button. The Security Alert window displays.
Figure 5. Security Alert window 5. Click the Yes button.
6
30 January 2004
The XML Registry home page displays.
Figure 6. XML Registry Home page when logged in
2.3 Updating Existing Registration Information
If any of your registration information changes, you may update the information at any time. To update your registration information:
7
30 January 2004
1. Log into the XML Registry. 2. Click the Registration button on the navigation bar, or click the user registration form link. The Registration Form displays with your information.
8
30 January 2004
Figure 7. Sample registration update form 3. Modify the information as needed. 4. Click the Update Registration button.
9
30 January 2004
Your information is updated and is displayed.
2.4 Resetting Your Password
To access the XML Registry if you should forget your password: 1. From the Login page, click the Forgot your password link. The Password Request Form displays.
Figure 8. Password Request Form 2. Enter your e-mail address and click the Submit button. The Password Request Form displays your reminder question.
10
30 January 2004
3. Enter the answer to your reminder question and click the Submit button. If you answered your reminder question correctly, the following message displays:
A new password has been created and mailed to you. Once logged in, please go to the Registration Section to change your password. If you do not receive a response within a couple of hours, please send a message to dataemp@fgm.com
11
30 January 2004
3. Navigating the XML Registry
3.1 Navigation Bar
The following options are available on the XML Registry navigation bar. Table 2. XML Registry Navigation Bar Options Navigation Bar Option XML Registry Home What’s New Description Displays the XML Registry home page. Displays the What’s New page which provides information on news, events, and important announcements regarding the XML Registry. Displays the Briefings and Documentation page which provides quick access to important documents. Displays general information about the XML Registry. Displays the XML Tools Links page. The XML Tools Link page provides links to other websites that may help with XML development. Displays the Search the Registry page. For more information, please see section 5. Displays the Registration Form. Displays the Related Links page. The Related Links page provides links to other websites that may help with XML development. Displays the Reports page. For more information, please see section 6. Displays the List of Subscribed Information Resources page. For more information, please see section 7. Displays the List of Changed Information Resources page. For more information, please see section 8. Displays the Briefcase Contents page. For more information, please see section 9.
Briefings & Documentation
Info Desk Tools
Search
Registration Links
Reports
Subscriptions
Changed IRs
Briefcase
12
30 January 2004
Navigation Bar Option MetaData Registry Home
Description Displays the Metadata Registry Home page. Please see the Metadata Registry and Clearinghouse User’s Manual for more information. Displays the COE home page (http://diicoe.disa.mil/coe/). Displays the Database Segments Home page. Please see the Database Segments Registry User’s Manual for more information. Displays the Data Element Registry Home page. Please see the Data Element Registry User’s Manual for more information. Displays the Reference Data Sets Gallery Home page. Please see the Reference Data Sets Gallery User’s Manual for more information.
COE Home DB Segments Home
Data Element Registry Home
Reference Data Sets Home
3.2 Links on the XML Registry Home Page
The following links are available on the XML Registry home page. Table 3. XML Registry Home Page Links Link Name User registration form What’s New Description Displays the Registration Form. Displays the What’s New page which provides information on news, events, and important announcements regarding the XML Registry. Displays the MID 905 Questionnaire.
Management Initiative Decision (MID) 905 Survey Questionnaire What is XML? Tell me more about the XML Registry How do I submit items to the XML Registry?
Displays general information about XML. Displays the Information about the DoD XML Registry page.
Displays information about the registry submission process.
13
30 January 2004
Link Name Show me the Namespaces
Description Displays the Namespaces page. For more information, please see section 4. Displays the Search the Registry page. For more information, please see section 5. Displays the Search Package Documents page. For more information, please see section 5.3. Displays the Current Inventory page. For more information, please see section 4.2. Displays the Package Validation and Submission Form. For more information, please see section 10.2. Displays the Submission Package Creation and Conversion Tool. For more information, please see section 10.3. Displays the Briefings and Documentation page which provides quick access to important documents. Displays the Request for System Registration page. For more information, please see section 11.2. Displays the Registered Systems List page. For more information, please see section 11.
Find XML Components and Information Resources Search the XML Registry Package Documents Review Current Inventory Status Jump to the Package Validation and Submission page Jump to the Package Creation/Conversion Tool Briefings and Documentation
Request New System User Registration View Registered Systems List
14
30 January 2004
4. Namespaces
A namespace is a label for data constructs that share a common context within a Community of Interest (COI). A COI is a collection of people, agencies, activities, and system builders who share an interest in a particular area or practical application. This implies a common world view as well as common abstractions, common data representations, and common metadata. Through the XML Registry, namespaces may publish their existence and their available information resources so that developers may discover them and assess whether or not they want to share.
4.1 Viewing Namespace Information
To view general namespace information: 1. From the XML Registry home page, click the Show me the Namespaces link. A list of the available namespaces displays. 2. Click the namespace name for which you want to view information. The Namespace Information page displays.
Figure 9. Sample Namespace Information page
15
30 January 2004
4.1.1 Viewing Information About the Namespace Manager To view information about the namespace manager, click on the namespace manager’s name from the Namespace Information page. 4.1.2 E-mailing the Namespace Manager You may e-mail the namespace manager by clicking the manager’s e-mail address from the Namespace Information page. 4.1.3 Viewing the Namespace Business Rules To view the IR status business rules for the namespace, click the Business Rules for Statuses of IRs in this Namespace link from the Namespace Information page.
4.2 Listing Namespaces and Their IRs
To list the available namespaces: 1. From the XML Registry home page, click the Show me the Namespaces link. A list of the available namespaces displays.
Figure 10. Namespace list and inventory link
16
30 January 2004
2. To view the IRs within a namespace, click the inventory link that appears on the line of the namespace. If the namespace contains IRs, the Current Inventory page displays the number of IRs in each IR type (submission package, schema, element, attributes, etc…).
Figure 11. Current Inventory page 3. To view the IRs in a particular category, click the number that appears under the category. The Search Results page displays the IRs found in the category that you selected.
17
30 January 2004
Figure 12. Search Results page From this page you can add the IRs to your briefcase or view the contents of your briefcase. For more information on working with the briefcase, please see section 8.
4.3 Viewing the Available IRs
To view the current inventory of IRs: 1. From the XML Registry home page, click the Review Current Inventory Status link. The Current Inventory page lists all namespaces that contain an IR along with the number of IRs in the type.
18
30 January 2004
Figure 13. Current Inventory page 2. To view the IRs in a particular category, click the number that appears under the category. The Search Results page displays the IRs found in the category that you selected. From this page you can add the IRs to your briefcase or view the contents of your briefcase. For more information on working with the briefcase, please see section 8.
19
30 January 2004
5. Searching the XML Registry
5.1 Using the Simple Search
The simple search allows you to search information resources fields (name, definition, comment, domain key, domain value documents) using words or phrases that you specify. To use the simple search feature of the XML Registry: 1. Click the Search button in the navigation bar. Or, click the Find XML Components and Information Resources link from the XML home page. The Search the Registry page displays. 2. Click the Simple Search link. The Search the Registry page displays.
Figure 14. Simple search page 3. To search for a specific word or phrase, enter the string in the Word or Phrase field. 4. To make the search case-sensitive, check the Case-Sensitive checkbox. Otherwise, leave the checkbox unchecked. 5. If you would like to search a specific field, select the field from the Search On dropdown list. Otherwise, leave the Search On set to All Fields.
20
30 January 2004
6. Click the Search button. The Search Results window displays the IRs found based on your search criteria.
5.2 Using the Advanced Search
The advanced search allows you to specify additional search criteria such as words contained in the IR, status, and version number. To use the advanced search feature of the XML Registry: 1. Click the Search button in the navigation bar. Or, click the Find XML Components and Information Resources link from the XML home page. The Search the Registry page displays.
Figure 15. Advanced search page 2. To search for a specific word or phrase, do the following: a. Enter the string in the Word or Phrase field. b. Check the Case-Sensitive checkbox to make the search case-sensitive. Otherwise, leave the checkbox unchecked. c. If you would like to search a specific field, select the field from the Search On
21
30 January 2004
drop-down list. Otherwise, leave the Search On set to All Fields. 3. To include all namespaces in the search, select the Search All Namespaces option. To search specific namespaces: d. Select the Search One or More of the Selected Namespaces option. e. Select one or more namespaces from the list. To select multiple namespaces, hold down the [CTRL] key while you select the namespaces from the list. 4. Select the information resource types that you want to include in the search from the Info Resource Type drop-down list. To search all IR types, leave the Info Resource Type set to All. 5. Select the status that you want to include in the search from the Status drop-down list. To include all statuses in the search, leave the Status set to All. 6. Select the version number that you want to include in the search from the Version dropdown list. To search all versions, leave the Version set to All. 7. Select the name of the person that submitted the IR from the Submitter drop-down list. To include all submitters in the search, leave Submitter set to All. 8. Select the date range that the search should include from the Start Date and End Date drop-down lists. 9. Click the Search button. The Search Results window displays the IRs found based on your search criteria.
5.3 Searching Package Documents
To search package documents: 1. From the XML Registry home page, click the Search the XML Registry Package Documents link. The Search Package Documents page displays.
22
30 January 2004
Figure 16. Search Package Documents page 2. Select the type of search that you would like to perform. 3. Enter the string(s) that you would like to find. 4. Click the Search button.
23
30 January 2004
6. Reports
6.1 Similar Information Resources
To run the Similar Information Resources report: 1. Click the Reports link on the navigation bar. The Reports page displays. 2. Click the Similar Information Resources link. The Similar Information Resources Report results display.
24
30 January 2004
7. Subscriptions
XML Registry users may request to be notified when an IR that they are interested in changes.
7.1 Viewing Your Subscriptions
To view IRs that you are subscribed, click the Subscriptions button on the navigation bar. The List of Subscribed Information Resources page displays the IRs to which you are currently subscribed.
7.2 Subscribing to a Package
To subscribe to a package: 1. Click the Subscriptions button on the navigation bar. The List of Subscribed Information Resources page displays the IRs to which you are currently subscribed. 2. Click the Add to Subscription link. The Subscribe Interest in Information Resource page displays. 3. Select the package that you are interested in from the Select a Package drop-down list. 4. Click the Select Package button. The Subscribe Interest in Information Resource page displays. 5. Select your level of interest from the Level of Interest drop-down list. Currently Using – This indicates that you are currently using the package. Keep Me Posted – This indicates that you are not using the package but are interested in being notified of changes to the package. 6. Check the types of events that you would like to be notified of from the Type of Notification options. Status Change – You will be notified if the package’s status changes Package Delete – You will be notified if the package is deleted Version Update – You will be updated if a new version of the package is available 7. To subscribe to the entire package, click the Subscribe to Entire Package button. The List of Subscribed Information for
page displays.
25
30 January 2004
7.3 Subscribing to IRs in a Package
To subscribe to specific IRs in a package: 1. Click the Subscriptions button on the navigation bar. The List of Subscribed Information Resources page displays the IRs to which you are currently subscribed. 2. Click the Add to Subscription link. The Subscribe Interest in Information Resource page displays. 3. Select the package that you are interested in from the Select a Package drop-down list. 4. Click the Select Package button. The Subscribe Interest in Information Resource page displays. 5. To subscribe to individual IRs in the package, click the Click Here to Select Individual IR’s in Package link. The Subscribe Interest in Information Resource page displays. 6. Click on the IR name that you would like to subscribe. The information for the selected IR displays. 7. Select your level of interest from the Level of Interest drop-down list. Currently Using – This indicates that you are currently using the package. Keep Me Posted – This indicates that you are not using the package but are interested in being notified of changes to the package. 8. Check the types of events that you would like to be notified of from the Type of Notification options. Status Change – You will be notified if the package’s status changes Package Delete – You will be notified if the package is deleted Version Update – You will be updated if a new version of the package is available 9. Click the Subscribe Interest button.
26
30 January 2004
7.4 Modifying a Subscription’s Interest Level or Notification Type
To modify your interest level or notification type for a subscription: 1. Click the Subscriptions button on the navigation bar. The List of Subscribed Information Resources page displays the IRs to which you are currently subscribed. 2. Click the name of the IR that you would like to modify. 3. Modify the notification type or subscription level as needed. 4. Click the Update Subscription button.
7.5 Unsubscribing to All IRs
To unsubscribe to all IRs that you are currently subscribed to: 1. Click the Subscriptions button on the navigation bar. The List of Subscribed Information Resources page displays the IRs to which you are currently subscribed. 2. Click the Unsubscribe All link.
7.6 Unsubscribing to Specific IRs
To unsubscribe to all IRs that you are currently subscribed to: 1. Click the Subscriptions button on the navigation bar. The List of Subscribed Information Resources page displays the IRs to which you are currently subscribed. 2. For each IR that you would like to unsubscribe, check the Unsubscribe checkbox. 3. Click the Unsubscribe Checked button.
27
30 January 2004
8. Changed IRs
To view a list of changed information resources: 1. Click Changed IRs on the navigation bar. The List of Changed Information Resources page displays. 2. Enter the date range in the from and to fields. 3. Click the Change Report Period button. A list of IRs that have changed is displayed.
28
30 January 2004
9. The Briefcase
The briefcase is an area where you can keep track of IRs in which you are interested. At any point you may remove IRs from your briefcase, or download the IRs.
9.1 Adding an Information Resource to the Briefcase
IRs may be added to the briefcase from any Search Results page. IRs that are not already in the briefcase will have the IR to the briefcase, click the icon. The icon will change to the briefcase. icon next to the IR name. To add the to show that the IR was added to
9.2 Viewing the Briefcase’s Contents
To view the contents of your briefcase, click the Briefcase button on the navigation bar. If you are on a Search Results page, you may also click the contents. icon to view the briefcase’s
The Briefcase Contents page displays with a list of the IRs that you have added to the briefcase.
Figure 17. Sample Briefcase Contents page
29
30 January 2004
9.3 Removing a Single Information Resource from the Briefcase
To remove a single IR from the briefcase: 1. Display the briefcase contents. 2. From the Briefcase Contents page, click the would like to remove from the briefcase. The IR is removed from the briefcase. icon that appears next to the IR that you
9.4 Removing All Information Resources from the Briefcase
To remove all IRs from the briefcase: 1. Display the briefcase contents. 2. From the Empty Briefcase button.
9.5 Downloading the Information Resources in the Briefcase
To download the IRs in the briefcase: 1. Display the briefcase contents. 2. Click the Download IRs button. 3. Enter the e-mail address where the IRs should be sent is correct. The e-mail address of the currently logged in user will be the default. 4. Click the Download IRs button. The IRs are compressed into a .zip file and e-mailed to the specified address and the message “INFO The Information Resources were successfully downloaded and emailed to the user.” is displayed.
9.6 Creating a Schema from the Information Resources in the Briefcase
To create a schema from the IRs in the briefcase: 1. Display the briefcase contents. 2. Click the Create schema button. The Create Schema from Briefcase page displays.
30
30 January 2004
Figure 18. Create Schema from Briefcase page 3. Enter the e-mail address where you would like the schema to be sent in the The new schema will be sent to the following e-mail address field. 4. Click the Create Schema button. An informational message displays stating that the schema file was successfully generated and e-mailed.
31
30 January 2004
Figure 19. Sample schema file
32
30 January 2004
10. Submission Packages
Submission packages are zip files that contain a logical collection of schema, elements, attributes, and documents.
Figure 20. Sample submission package
10.1 Creating Submission Packages
A submission package is a .zip file that includes the elements, attributes, documents, domains, and schemas that you want to register with the XML Registry. 10.1.1 Creating Information Resources You will want to consider the following rules and conventions when creating new IRs for the XML Registry: 1. Include descriptive definitions AND synonyms for the IR definition. Initially, the Registry will not have keyword, thesaurus, or ontology support but it will have a substring search for a number of fields, including definition. Therefore, we urge submitters to include enough expressive terms so that COE developers can easily find the term they might consider "natural" in the definition, and find the desirable Information Resource for expressing that concept. Example: If the registered Information Resource is ORG_ID, the description that includes references to "military unit," "organization," and "UIC" would be appropriately returned from most search efforts. 2. Use UpperCamelCase for elements, lowerCamelCase for attributes. UpperCamelCase is a naming convention in which multiple words are joined together to form a single word. The initial letter of each original word is then capitalized. For example, DateOfBirth. 33 30 January 2004
lowerCamelCase is similar in that multiple words are joined together to form a single word. However, with lowerCamelCase, the initial letter of the new word is lower case. For example, socialSecurityNumber. 10.1.2 Creating the Manifest.xml File Each submission package must contain a file named manifest.xml that defines all IRs that you want to register and the associations between those IRs and existing IRs. The manifest.xml must conform to the registry.xsd or registry.dtd. Use the following Document Type Definitions (DTD) or XML Schema Documents (XSD) for your Submission Package:
registry.dtd registry_domain_values.dtd registry.xsd registry_domain_values.xsd registry_schema_groups.xsd registry_schema_types.xsd
In addition, the manifest.xml must begin with information about the submitter.
Mrs. Mary Gilligan 7034789881 mary@mailbox.fgm.com FMG Inc.
10.1.3 Registry Validation Rules Packages submitted to the XML Registry must conform to the following rules to pass validation: All IRs must have a unique combination of name, namespace, IR type, and version. (IR names are not case-sensitive.) All referenced IRs must exist within the Registry or within the submission package being processed Values submitted with the manifest.xml must not exceed the length of the database field Values submitted with the manifest.xml are checked to ensure that they are not longer than the database fields The person submitting the package must be a registered XML Registry user. Submitter must exist as a registered XML Registry user; e-mail address is used to uniquely identify All new IRs in the package should belong to the same namespace and specified within the package IR. Referenced IRs can come from different namespaces. XML Registry is unaware of version hierarchy and doesn’t know that 1.0.1 is a later version of 1.0.0. Version numbers are represented as strings of 15 characters or less.
34
30 January 2004
10.2 Validating and Submitting Packages
To validate and submit packages: 1. From the XML Registry home page, click the Jump to the Package Validation and Submission page link. The Package Validation and Submission Form displays. 2. Click the Browse button. The Choose file window displays. 3. Select the .zip file that contains the package that you would like to submit. 4. Click the Open button. The directory and filename are displayed in the Name of Zip file to be validated field. 5. If you would like to submit the package after it is validated, check the Check here to submit the package checkbox. If you would like to only validate the package but not submit it, leave the checkbox unchecked. 6. If you would like an e-mail confirmation sent to you after the package has been validated, enter your address in the Email Address field. 7. Click the Validate Zip File button to validate and/or submit. Or, to clear the form, click the Reset Form Values button.
10.3 Creating and Converting Packages
To upload a schema: 1. From the XML Registry home page, click the Jump to the Package Creation/Conversion Tool link. The Submission Package Creation and Conversion Tool page displays. 2. Click the Browse button. The Choose file window displays. 3. Select the file that contains the package that you would like to convert. 4. Click the Open button.
35
30 January 2004
5. Click the Upload Schema File button. The name of the schema that you chose to update is displayed at the bottom of the Submission Package Creation and Conversion Tool page.
Figure 21. Submission Package Creation and Conversion Tool 6. Click the Process Schema File(s) button. The Submission Package Creation/Conversion Tool form displays.
36
30 January 2004
Figure 22. Submission Package Creation/Conversion Tool form 7. Enter the name of the package that the schema should be included in the Package Name field. 8. Enter the package’s version number in the Version Number field. 9. Enter the package’s effective date in the Effective Date field. 10. Select a security classification from the Security Classification drop-down list. 11. Enter the package’s definition in the Definition field. 12. Enter a comment for the package in the Comments field.
37
30 January 2004
13. Select the namespace that the package will be in from the Namespace drop-down list. 14. Enter the submitter’s name in the Submitter field. 15. Enter the e-mail address to which the manifest file should be sent in the E-mail Address field. 16. Click the Process Schema File(s) button. The following message displays:
INFO The Manifest.xml file was successfully generated and emailed to
38
30 January 2004
11. Registered Systems
11.1 Viewing Registered Systems
To view the registered systems: 1. From the XML Registry home page, click the View Registered Systems link. The Registered Systems List page displays. 11.1.1 Viewing Registered Systems To view information about a particular system, click the system name. 11.1.2 Viewing a Registered Systems Point of Contact To view information about the point of contact (POC), click the POC’s name.
11.2 Requesting New System User Registration
To view the request new system user registration: 1. From the XML Registry home page, click the Request New System User Registration link. The Request for System Registration page displays. 2. Enter the system’s name in the System Name field. 3. Enter the system user id in the System UserID field. 4. Enter the password for the system in the Password field. 5. Enter any comments about the system in the Comments field. 6. Enter the e-mail address of the point of contact in the UserID field. By default, the email address of the current user is entered in the UserID field. 7. To submit the request, click the Submit Request button. Otherwise, click the Cancel button.
39
30 January 2004
12. Feedback and Comments
Clicking the Feedback and Comments link at the bottom of any page takes you to the Feedback and Comments page.
Figure 23. The Feedback and Comments Page This page allows you to submit comments/questions regarding the DoD XML Registry. To use this page: 1. Select the type of comment you are submitting. 2. Enter your comments in the Enter your Comments in the Space Provided Below field. 3. If you would like an expedited reply, click the box next to Please contact me as soon as possible regarding this matter. 4. Click the Submit Comments button. 5. To clear the form and start again, click the Clear Form button.
40
30 January 2004
Appendix A – Information Resources
What is an Information Resource?
An Information Resource (IR) is a generic term used for each object in the XML Registry. These objects may include elements, attributes, and documents registered in the XML Registry. The current version of the XML Registry supports the IR types listed in Table 4. Table 4. Supported Information Resource Types
Information Resource Type Submission package XML element Registry Manifest Document Term Description
Package
InformationResourceTypeXMLElement
XML attribute
InformationResourceTypeXMLAttribute
A logical collection of elements, attributes, and documents that are submitted to the XML Registry. An XML element, either complex or a terminal node (a container element or data element). An XML attribute that may be associated with one or more XML elements. Attributes provide additional information about elements
Supporting document
InformationResourceTypeDocument
Domain value document
InformationResourceTypeDomainDocument
Schema document
InformationResourceTypeXMLschema
Sample XML document
InformationResourceTypeXMLSample
Sample source code
InformationResourceTypeSourceCode
A Word, PDF, or ASCII text document that may be associated with one or more information resources. A document containing the valid domain values for an XML element or XML attribute. This document is also a XML file adhering to the registry_domain_values.dtd A schema document such as a DTD that describes the structure of a document. The following types are currently supported: DTD; RDF; SOX; XDR; DCD; DML; BIZ; XSD; and OSC. An XML file that conforms to a schema document (see above) described in this submission package. One or more files (possibly a zip file) that shows how to parse or
A-1
30 January 2004
Information Resource Type XSL stylesheet
Registry Manifest Document Term
Description
InformationResourceTypeXSLStylesheet
Schema data type Complex type
InformationResourceTypeSchemaDataType
InformationResourceComplexType
use the sample XML document. An XSL stylesheet that specifies the presentation of a class of XML documents by describing how an instance of the class is transformed into an XML document that uses the formatting vocabulary. A data type that is used within a schema document to describe XML elements or attributes. A data type that is used within a schema document to describe XML elements or attributes that are collections of other elements or attributes.
Information Resource Relationships Within the XML Registry
The XML Registry manages the concept of relationships that may exist between Information Resources within the XML Registry. Most relationships in the XML Registry are defined by developers using Information Resources provided in the XML Submission Manifest document. Other relationships are defined automatically during the processing of submitted registry documents. Table 5 describes the types of relationships that are currently supported by the XML Registry. Future versions of the Registry will provide support for additional relationships. Table 5. Relationships Supported by the XML Registry
Information Registry Manifest Related Cardinality Applicability Resource Document Relationship Information Type Resource XML Element Contains XML Element 0, 1, or many A container data element. XML Element Contains XML Attribute 0, 1, or many A container data element. XML Element Contains XML 0, 1, or many A container data Document element. XML Element IsDerivedFrom Schema Data 0 or 1 An element is the child Type of a schema data type. XML Element IsQualifiedByAttribute XML Attribute 0,1, or many A container or terminal node XML Element with attributes. XML Element DescribedBy Document 0,1, or many A container or terminal node XML Element with documents that describe the element.
A-2
30 January 2004
Information Registry Manifest Related Cardinality Applicability Resource Document Relationship Information Type Resource XML Element IsConstrainedByDomain Domain 0 or 1 A terminal node XML Document Element with a defined list of domain values. XML DescribedBy Document 0,1, or many An XML Attribute with Attribute documents that describe the element. XML IsConstrainedByDomain Domain 0 or 1 An XML Attribute with Attribute Document a defined list of domain values. XML IsDerivedFrom Schema Data 0 or 1 An attribute is the child Attribute Type of a schema data type. Complex Type ComplexTypeContains Complex Type 1 or many A complex type entity that contains the given complex type. Complex Type ComplexTypeContains Schema Data 1 or many A complex type entity Type that contains the given schema data type. Complex Type ComplexTypeContains XML Element 1 or many A complex type entity that contains the given XML element. Complex Type IsQualifiedByAttribute XML Attribute 1 or many A complex type entity that contains or is qualified by the given XML attribute. Complex Type ComplexTypeExtends Complex Type 0 or 1 A complex type entity that extends the given complex type as a derived type. Complex Type ComplexTypeRestricts Complex Type 0 or 1 A complex type entity that restricts the given complex type as a derived type. Schema IsXMLSpecFor XML Element 1 or many A schema document Document that uses the specified XML Elements. Any IsNewerVersionOf Any 0 or 1 An information Information Information resource has been Resource Resource declared based on an (same type as existing IR. the first IR)
Element and Attribute Data Types Supported by the XML Registry
The Registry requires that XML Elements and XML Attributes have a data type associated with them. Table 6 describes the data types currently supported. Additional Information Resources
A-3
30 January 2004
that describe the data may be required or optional Information Resources may provide additional information to assist in understanding the use of the element or attribute. The Registry now supports the notion of user defined data types based on the simple data types supported by XML Schema Documents (XSD). Table 7 lists the additional XSD data types and Table 8 lists the "facet" Information Resources that supply amplifying information about the data types. Table 6. Element/Attribute Data Types
Attribute or Element Data Type String Integer Float Container of other Data Types No Content Registry Manifest Term DataTypeString DataTypeInteger DataTypeFloat DataTypeContainer Required elements StringLength IntegerLength FloatLength Contains Optional elements
IntegerUnitMeasure FloatUnitMeasure, Float Precision
DataTypeEmpty
Table 7. XML Schema Document (XSD) Simple Data Types Description / Example an array of characters in XML a string with carriage returns, linefeeds, and tabs treated as a spaces a tokenized, normalized string a short integer with a value that ranges from 127 to -128 an unsigned short with a max value of 255 arbitrary sequence of base 64 encoded data as defined in W3C [RFC 2045] hexBinary arbitrary sequence of hex encoded data integer any whole number positiveInteger any whole number with a value greater than 0 negativeInteger any whole number with a value less than 0 nonNegativeInteger any whole number with a value greater than or equal to 0 nonPositiveInteger any whole decimal number with a value less than or equal to 0 int an integer with a value in the range of 2147483647 to -2147483648 unsignedInt an integer with a value in the range of 0 to 4294967295 long an integer with a value in the range of 9223372036854775807 to 9223372036854775808 unsignedLong an integer with a value in the range of 0 to 18446744073709551615 short an integer with a value in the range of 32767 to -32768 unsignedShort an integer with a value in the range of 0 to 65536 decimal a floating point number with arbitrary precision float a 32 bit single precision IEEE floating point number A-4 30 January 2004 Simple Data Type string normalizedString token byte unsignedByte base64Binary
double boolean time dateTime duration date gMonth gYear gYearMonth gDay gMonthDay Name QName NCName anyURI language ID IDREF IDREFS ENTITY ENTITIES NOTATION NMTOKEN NMTOKENS
a 64 bit double precision IEEE floating point number a binary value equal to true, false, 1, or 0 a daily recurring instance of time formatted in accordance with [ISO 8601] (ex 23:59:59) a specific instance of time formatted in accordance with [ISO 8601] (ex 2001-07-30T23:59:59) a length of time formatted in accordance with [ISO 8601] Gregorian calendar date Gregorian calendar month Gregorian calendar year Gregorian calendar year and month Gregorian calendar day Gregorian Month and Day a token which represents XML Names a Name qualified by a namespace a "non-colonized" Name represents a Universal Resource Identifier natural lauguage identifiers represents the ID attribute type for DTDs represents the IDREF attribute type for DTDs represents the IDREFS attribute type for DTDs represents the ENTITY attribute type for DTDs represents the ENTITIES attribute type for DTDs represents the NOTATION attribute type for DTDs represents the NMTOKEN attribute type for DTDs represents the NMTOKENS attribute type for DTDs
Table 8. XML Schema Document (XSD) Data Type Facets Facet Name minInclusive maxInclusive minExclusive maxExclusive whiteSpace length minLength maxLength totalDigits fractionDigits pattern enumeration UnitMeasure Description inclusive minimum value of a range of values inclusive maximum value of a range of values exclusive minimum value of a range of values exclusive maximum value of a range of values value of whiteSpace must be one of {preserve, replace, collapse} the number of units of length for a given data type the minimum length of a data type the maximum length of a data type the maximum number of digits in a decimal number the maximum number of digits in the fractional portion of a decimal number constrains values to string which match the specified pattern constrains values to a fixed set of values non-XSD facet used to specify the unit of measure for a number
A-5
30 January 2004