Docucomp Component Management System

From NOAA Environmental Data Management Wiki

http://www.ngdc.noaa.gov/docucomp

Docucomp is a web application for managing XML components as part of an Enterprise Documentation Architecture. A component is a snippet of XML describing a specific piece of metadata content. They are stored in a database and managed with REST web services. The REST services support insert, search, update and delete operations.

Presentations

File:DocucompHowTo.ppt

Insert Component

The component library is a collection of components stored in the Docucomp database. Below are the steps for adding a component to the Library.

1. Prepare component for insert:

a. Make sure component is well-formed XML.
b. Make sure component includes a namespace declaration for each namespace used in the component.
c. Components are identified using UUIDs. If you wish to assign a UUID to the component, it must be included in the root element of the component. If it is not included, Docucomp will assign a UUID constructed by the underlying database system..

The UUID and namespace declarations are added to the root element of the component. Components do not require a header XML declaration. A sample component is shown below. Note how the gmd and gco namespaces and a UUID are declared in the root element of the component.

<gmd:CI_OnlineResource 
  xmlns:gmd="http://www.isotc211.org/2005/gmd" 
  xmlns:gco="http://www.isotc211.org/2005/gco" 
  uuid="e38c87c0-4404-11df-9d12-0002a5d5c51b">
  <gmd:linkage>
    <gmd:URL>http://uhslc.soest.hawaii.edu/uhslc/jasl.html</gmd:URL>
  </gmd:linkage>
  <gmd:name>
    <gco:CharacterString>University of Hawaii Sea Level Center JASL Home Page</gco:CharacterString>
  </gmd:name>
  <gmd:function>
    <gmd:CI_OnLineFunctionCode codeList="http://www.isotc211.org/2005/resources/Codelist/gmxCodelists.xml#CI_OnLineFunctionCode" codeListValue="information">information</gmd:CI_OnLineFunctionCode>
  </gmd:function>
</gmd:CI_OnlineResource>

2. Insert Process: To insert a component into the database go to Docucomp web interface.

Create component page
a. Log In to Docucomp. If you are not a Docucomp user, visit the Docucomp Account Setup Page for 'New User' Instructions.
b. Click on the 'Insert New Component' link (upper right)
c. Paste the component into the 'XML' text box and click the 'create' button.
d. If Potential Duplicate components are presented, see the Duplicate Components section below.
e. When the component is successfully inserted, the 'Show Component' page will be returned.
- During the submission process the service ensures the component is well formed and contains the required namespaces.
- If the component is not well formed or is missing required namespaces an error message will be returned. The user must fix the error before resubmitting.
e. To fix an xml error, click the back button to return to the XML display page. Edit the component XML and recreate the component. An xml editor such as 'Oxygen' or 'Xml Spy' is ideal for finding and fixing XML errors.

Duplicate Components

During the component insert process Docucomp checks to see if the component being inserted already exists in the database. If similar components are found they are presented to the user as 'Potential Duplicates'. The user then has the option to 'Keep' or 'Cancel' the operation. If the component is determined to be unique the user should click the 'Keep' button to complete the insert process. If a duplicate component is discovered the user should click the 'Cancel' button to cancel the insert process, and continue to use the found, pre existing component. This service is a warning system to prevent duplicate components from being inserted into the Docucomp database.

Search for Components

Search for component

Docucomp search options include; component xml (Content), component identifier (UUID), Component Type and Record Set. These search options are accessible from the Docucomp Home Page.
1. Enter a string in the 'Content' search field to return components containing the search string
2. Enter a component UUID in the 'UUID' search field to return a component by UUID
3. Select a Record Set from the drop down menu to filter your search results by the selected Record Set
4. Select a Component Type from the drop down menu to filter your search results by the selected Component Type 5. Your search results will be presented in the 'Component List' page, where searches can be modifed or filtered.

Quick Search

Quick Search

Most components have at least one field indexed upon insert. The quick search is an AJAX driven search of indexed component fields. This quick, efficient search retrieves possible matches on the fly. With each key stoke matches are filtered, making it easy for users to find components without knowing the exact spelling.
1. Navigate to the Docucomp Home Page
2. Click the 'Quick Search' link (upper right) under the 'Quick Links' heading.
3. Enter a search string in the 'Content' field.
4. The search results are presented on the fly below the 'Results' heading.
5. Click the 'UUID' link from Results list to retrieve the component.

Update a Component

Edit component page

Docucomp users must be registered in order to perform edit operations.
1. Log In to Docucomp. If you are not a Docucomp user, visit the Docucomp Account Setup Page for 'New User' Instructions.
2. Search for the component you want to update.
3. Search results will be displayed in the 'Component List' page. Click the 'Edit' button to the left of the component you want to edit to access the 'Edit Component' page.
4. Edit the 'XML' field and click the Update button.
5. Upon update the edit results are presented in the 'Show Component' page.
Note: Component xml must be well formed and contain the required namespaces in order to update. If a component fails to update make sure the XML is well formed and contains all the required namespaces. An XML editor such 'Oxygen' or 'Xml Spy' is ideal for this purpose.

Delete a Component

Docucomp users must be registered in order to delete a component
1. Log In to Docucomp. If you are not a Docucomp user, visit the Docucomp Account Setup Page for 'New User' Instructions.
2. Search for the component you want to update.
3. Search results will be displayed in the 'Component List' page. Click the 'Edit' button to the left of the component you want to edit to access the 'Edit Component' page.
4. Click the 'Delete' button from the 'Edit Component' page to remove the component from the Docucomp database.