Versions Compared

Version Old Version 19 New Version Current
Changes made by

TB (Unlicensed)

Sambasiva Madalam

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

...

http://dev.docstore.ole.kuali.org/

2. Operations

2.1 Summary

Shows  Shows the summary of node record count for each category, type and formath

 

2.2

...

Shows node count at each level of the docstore for each  category, type and format

...

Ingest

 

Allows storing of documents in the document store. The input should be a Request XML with a standard schema and returns the Response XML with a list of ingested UUIDs.

2.

...

2.1 Sending the request

URL: http://localhost:9080/oledocstore/dev.docstore.ole.kuali.org/document

Method: POST

Parameters:

                  docAction=ingestContent

                  stringContent=<request.xml as described in the next section>

2.

...

2.2 Request XML

Information about the ingest operation to be performed.

No Format
  <request>
    <user>ole-khuntley</user>
    <operation>batchIngest<<operation>ingest</operation>
    <requestDocuments>
        <ingestDocument id="1" category="work" type="bibliographic" format="marc">
            <content>
        See section "Sample Input XML for Ingest".
    </content>
        </ingestDocument>
    </requestDocuments>
</request>

2.

...

2.3 Receiving the response

HttpResponse should be read and interpreted as given in the next section below.

2.

...

2.4 Response XML

Information about the response from the service for the given request

No Format

 <response>
  <documents>
    	<document id="1" category="work" type="bibliographic" format="marc">
      	    <uuid>8675a422-b6ad-440e-bc0d-9f0dc1526ed2<<uuid>10000004</uuid>
	</document>
   </documents>
<user>ole-khuntley</user>
<operation>batchIngest<<operation>ingest</operation>
<status>Success</status>
<message>Documents ingested</message>
</response>

Each document that is ingested will be given a UUID as specified in the response.

2.

...

User can get a sample of UUIDs of documents of any category, type, format.

already ingested.

It is useful mainly for demo purposes.

2.5 Check-in

...

3 Check-in

Check-in functionality allows to modify the content and metadata (additional attributes) of a document identified by its UUID (Universally Unique Identifier).

2.

...

3.1 Sending the request

URL: http://localhost:9080/oledocstore/dev.docstore.ole.kuali.org/document

Method: POST

Parameters:

                  docAction=checkIn

                  stringContent=<request.xml as described in the next section>

2.

...

3.2 Request XML

           Information about the check in  operation to be performed     

No Format

 <request>
    <user>ole-khuntley</user>
    <operation>checkIn</operation>
    <requestDocuments>
        <ingestDocument id="5325d77a-8221-4fda-a78f-6d2f96e0b05910000004" category="work" type="bibliographic" format="marc">
            <content>
                type="bibliographic" format="marc">
            <content>
		See 		See section "Sample Input XML for Check in".
	</content>
        </ingestDocument>
    </requestDocuments>
</request>

2.

...

3.3 Receiving the response

HttpResponse should be read and interpreted as given in the next section below.

2.

...

3.4 Response XML

            Information about the response from the service for the given request 

No Format
  <?xml version<response>
  <documents>
    	<document id="1.0" encodingcategory="UTF-8work"?>
<OLEDocstore-call>
	<request>
		<command>Check-in</command>
		<params/> type="bibliographic" format="marc">
      	    <uuid>10000004</uuid>
	</request>document>
	<response> 		<status>Success</status> 		<message>Successfully checked in </message>
	</response>
</OLEDocstore-call> </documents>
<user>ole-khuntley</user>
<operation>checkIn</operation>
<status>Success</status>
</response>

2.

...

4 Check-out

This operation retrieves the content of a document given its UUID.

2.

...

4.1 Sending the request

URL: http://localhost:9080/oledocstore/dev.docstore.ole.kuali.org/document

Method: POST

Parameters:

                  docAction=checkOut

                  uuid=<uuid of the document to be retrieved>

2.

...

4.2 Receiving the response

            HttpResponse should be read and interpreted as given in the next section below.

2.

...

4.3  Response XML

Content of the document with the given UUID.

2.

...

5 Delete

Deletes a record from DocumentStore based on the given UUID.

2.

...

5.1 Sending the request

URL: http://localhost:9080/oledocstore/dev.docstore.ole.kuali.org/document

Method: POST

Parameters:

                  docAction=delete or deleteWithLinkedDocs

                  requestContent=<request.xml as described in the next section>

2.

...

5.2  Request XML

         Information about the delete  operation to be performed. The "Id" attribute of <ingestDocument> should be a valid UUID of a previously ingested document.

No Format

 <request>
    <user>ole-khuntley</user>
    <operation>delete</operation>
    <requestDocuments>
<ingestDocument id="715e92f0-b3ab-4263-96d9-58183a23e6d5"><linkedIngestDocuments></linkedIngestDocuments><10000004"></ingestDocument>
 </requestDocuments>
</request>

2.

...

5.3  Receiving the response

             HttpResponse should be read and interpreted as given in the next section below.

2.

...

5.4  Response XML

 Information about the response from the service for the given request.

No Format
  <response>
  <documents>
    <document id="715e92f0-b3ab-4263-96d9-58183a23e6d510000004"></document>
  </documents>
  <user>ole-khuntley</user>
  <operation>delete</operation>
  <status>Success</status>
</response>

2.

...

6 Bulk Ingest (Admin function)

Bulk ingest process is used for loading the docstore repository with large amounts of document information.

...

The input data is copied to a "ole-batchUpload" directory on the server (specified by documentstore.properties)

Go to http://localhost:8080/oledocstoredev.docstore.ole.kuali.org/admin.jsp and 'Bulk Ingest' tab.

Click the button to start the process. Once started, the process runs in background and waits for input files to become available in the "ole-batchUpload" directory.

...

To verify that the data is stored in DocumentStore, go to URL

           http://localhost:8080/oledocstoredev.docstore.ole.kuali.org

           Click "Refresh Summary" button in the Summary tab.

...

To verify that the data is indexed in DocStore, go to URL

        http://localhost:8080/oledocstoredev.docstore.ole.kuali.org/discovery

         Click "Refresh" button in the Summary tab.

         Note the count for each DocType.

2.

...

7 Rebuild indexes (Admin function)

Sometimes the indexed data in Docstore may get corrupted. Or the data may need to be reindexed due to changes in indexing criteria and search/sort/facet rules.

In these cases the Docstore data can be re-indexed. This is also done by the Admin user.

Go to to http://localhost:8080/oledocstoredev.docstore.ole.kuali.org/admin.jsp and 'Reindex' tab.

Click the 'Start' button to start the process.

...

To verify that the data is indexed in DocStore, go to URL

        http://localhost:8080/oledocstore/dev.docstore.ole.kuali.org/discovery

         Click "Refresh" button in the Summary tab.

         Note the count for each DocType and verify with DocStore count.

2.

...

8 Ingest Binary data (BagIt Requests)

When the document content is of (non-text or binary) format PDF, DOC etc, (as in the case of License Agreement documents) it is difficult to send it to docstore through a web page.

...

This functionality can be demonstrated using the "BagIt Requests" tab in thehttp://dev.docstore.dev.ole.kuali.org/oledocstore/screen.

To submit a request of this type follow these steps:

...

3.0.1  Sample Input XML for Ingest

No Format
  <request>
    <user>ole-khuntley</user>
    <operation>batchIngest</operation>
    <requestDocuments>
        <ingestDocument id="1" category="work" type="bibliographic" format="marc">
            <content><![CDATA[
            <collection xmlns="http://www.loc.gov/MARC21/slim">
    <record>
        <leader>01142cam 2200301 a 4500<<leader>#####nam#a22######a#4500</leader>
    <controlfield tag="001">3</controlfield>
        <controlfield tag="001">92005291<003">OCoLC</controlfield>
        <controlfield tag="005">20090213152530.7</controlfield>
        <controlfield tag="003008">DLC</controlfield>>131031s########xxu###########000#0#eng#d</controlfield>
        <datafield tag="035" ind1=" " ind2=" ">
            <subfield code="a">(OCoLC)ocm62378465</subfield>
        </datafield>
        <datafield tag="040" ind1=" " ind2=" ">
             <subfield code="a">DLC</subfield>
             <subfield code="c">DLC</subfield>
             <subfield code="d">DLC</subfield>
             <subfield code="d">HLS</subfield>
             <subfield code="d">IUL</subfield>
        </datafield>
         <datafield tag="022" ind1=" " ind2=" ">
            <subfield code="a">1729-1070|20</subfield>
        </datafield>
        <datafield tag="029" ind1="1" ind2=" ">
            <subfield code="a">AU@|b000040176476</subfield>
            <subfield code="b">000040176476</subfield>
        </datafield>
        <datafield tag="037" ind1=" " ind2=" ">
            <subfield code="b">The Managing Editor, BIAC Journal, P.O. Box 10026, Gaborone, Botswana</subfield>
        </datafield>
        <datafield tag="042" ind1=" " ind2=" ">
            <subfield code="a">lc</subfield>
        </datafield>
        <datafield tag="043" ind1="1" ind2="0">
            <subfield code="a">f-bs---</subfield>
        </datafield>
        <datafield tag="050" ind1="0" ind2="0">
            <subfield code="a">HD70.B55|bB53</subfield>
        </datafield>
        <datafield tag="049" ind1=" " ind2=" ">
            <subfield code="a">IULA</subfield>
        </datafield>
         <datafield tag="210" ind1="1" ind2=" ">
            <subfield code="a">BIAC j.</subfield>
        </datafield>
         <datafield tag="222" ind1=" " ind2="0">
            <subfield code="a">BIAC journal</subfield>
        </datafield>
         <datafield tag="245" ind1="0" ind2="0">
            <subfield code="a">The administration of justice. BIAC journal</subfield>
        </datafield>
         <datafield tag="246" ind1="1" ind2="3">
            <subfield code="a">Botswana Institute of Administration and Commerce journal</subfield>
        </datafield>
        <datafield tag="260" ind1=" " ind2=" ">
            <subfield code="a">Gaborone, Botswana :|bBotswana Institute of Administration and Commerce</subfield>
            <controlfield<subfield tagcode="005">19930521155141.9</controlfield>
    b">Botswana Institute of Administration and Commerce</subfield>
   <controlfield tag="008">920219s1993 caua j 000 0 eng<</controlfield>datafield>
        <datafield tag="010300" ind1=" " ind2=" ">
            <subfield code="a">92005291<">v. ;</subfield>
            <subfield code="c">24 cm.</subfield>
        </datafield>
        <datafield tag="020300" ind1=" " ind2=" ">
            <subfield code="a">0152038655>v. :;</subfield>
            <subfield code="c">$15>24 cm.95<</subfield>
        </datafield>
        <datafield tag="040300" ind1=" " ind2=" ">
            <subfield code="a">DLC<>v. ;</subfield>
            <subfield code="c">DLC</subfield>
            <subfield code="d">DLC<>24 cm.</subfield>
        </datafield>
        <datafield tag="042310" ind1=" " ind2=" ">
            <subfield code="a">lcac<>Semiannual</subfield>
        </datafield>
        <datafield tag="050362" ind1="01" ind2="0 ">
            <subfield code="a">PS3537.A618</subfield>> Began            <subfield code="b">A88 1993<in 2004.</subfield>
        </datafield>
        <datafield tag="082500" ind1="0 " ind2="0 ">
            <subfield code="a">811/.52</subfield>
            <subfield code="2">20<>Description based on: Vol. 1, no. 1 (May. 2004); title from cover.</subfield>
        </datafield>
        <datafield tag="100500" ind1="1 " ind2=" ">
            <subfield code="a">Sandburg, Carl,</subfield>
            <subfield code="d">1878-1967>Latest issue consulted: Vol. 3, no. 1 (May 2006).</subfield>
        </datafield>
        <datafield tag="245650" ind1="10" ind2="0 ">
            <subfield code="a">Arithmetic>Industrial management</</subfield>
            <subfield code="cz">>Botswana</subfield>
            <subfield code="v">Periodicals.</subfield>
  Carl   Sandburg ; illustrated as</datafield>
an anamorphic adventure by Ted Rand.   <datafield tag="650" ind1="0" ind2=" ">
     </subfield>       <subfield  </datafield>code="a">Occupational training</subfield>
         <datafield tag="250" ind1=" "<subfield ind2code=" z">>Botswana</subfield>
            <subfield code="av">1st ed>Periodicals.</subfield>
        </datafield>
        <datafield tag="260710" ind1=" 2" ind2=" ">
            <subfield code="a">San>Botswana Diego :</subfield>
            <subfield code="b">Harcourt Brace Jovanovich,</subfield>
            <subfield code="c">c1993Institute of Administration and Commerce.</subfield>
        </datafield>
        <datafield tag="300850" ind1=" " ind2=" ">
            <subfield code="a">1 v. (unpaged) :</subfield>>DLC</subfield>
        </datafield>
        <subfield<datafield codetag="b891">ill. (some col.) ;</subfield> ind1="2" ind2="0">
             <subfield code="c">26 cm.<a">9853|81.1</subfield>
        </datafield>         <datafield tag="500" ind1=" " ind2=" "><subfield code="a">v.</subfield>
            <subfield code="ab">One>no</subfield>
Mylar sheet included in pocket.</subfield>         </datafield><subfield code="u">2</subfield>
         <datafield tag="520" ind1=" "<subfield ind2code=" v">>r</subfield>
            <subfield code="ai">(year)</subfield>
            <subfield code="j">(month)</subfield>
     A   poem about numbers and their characteristics. Features anamorphic, or distorted,<subfield code="w">f</subfield>
            <subfield code="x">05</subfield>
      drawings which can</datafield>
be        <datafield tag="891" ind1="4" ind2="1">
     restored to normal by viewing from a particular angle or by viewing the image's<subfield code="a">9863|81.1</subfield>
            <subfield code="a">1</subfield>
       reflection in the   <subfield code="b">1</subfield>
            provided Mylar cone.<subfield code="i">2004</subfield>
             <<subfield code="j">05</subfield>
        </datafield>
        <datafield tag="650596" ind1=" " ind2="0 ">
            <subfield code="a">Arithmetic<>1</subfield>
        </datafield>
   <subfield code="x">Juvenile poetry.</subfield>
       record>
</datafield>collection>
         <datafield tag="650" ind1=" " ind2="0">   ]]>
         <subfield code="a">Children's poetry, American.</subfield>content>
            </datafield>!--optional -->
           <datafield tag="650" ind1=" " ind2="1"><additionalAttributes>
               <subfield code="a">Arithmetic</subfield> <dateEntered></dateEntered>
               <subfield code="x">Poetry.</subfield> <lastUpdated></lastUpdated>
             </datafield>   <fastAddFlag></fastAddFlag>
     <datafield tag="650" ind1=" " ind2="1">       <supressFromPublic></supressFromPublic>
     <subfield code="a">American poetry.</subfield>         <<harvestable></datafield>harvestable>
          <datafield tag="650" ind1=" " ind2="1">  <status></status>
          <subfield code="a">Visual perception.</subfield>     <createdBy></createdBy>
     </datafield>         <datafield tag="700" ind1="1" ind2=" "> <updatedBy></updatedBy>
              <subfield code="a">Rand, Ted,</subfield> <statusUpdatedOn></statusUpdatedOn>
             <subfield code="e">ill.</subfield>  <statusUpdatedBy></statusUpdatedBy>
      </datafield>     </record> </collection>    <staffOnlyFlag>true</staffOnlyFlag>
            ]]></additionalAttributes>
            <<linkedIngestDocuments></content>linkedIngestDocuments>
        </ingestDocument>

    </requestDocuments>
</request>

3.0.2  Sample Input file for Check In

The "Id" attribute of <ingestDocument> should be a valid UUID of a previously ingested document.

No Format

 <request>
    <user>ole-khuntley</user>
    <operation>checkIn</operation>
    <requestDocuments>
        <ingestDocument id="1" category="work" type="bibliographic" format="marc">
            <content><![CDATA[
<collection xmlns="http://www.loc.gov/MARC21/slim">
    <record>
        <leader>01142cam 2200301 a 4500</leader>
        <controlfield tag="001">92005291</controlfield>
        <controlfield tag="003">DLC</controlfield>
        <controlfield tag="005">19930521155141.9</controlfield>
        <controlfield tag="008">920219s1993 caua j 000 0 eng</controlfield>
        <datafield tag="010" ind1=" " ind2=" ">
            <subfield code="a">92005291</subfield>
        </datafield>
        <datafield tag="020" ind1=" " ind2=" ">
            <subfield code="a">0152038655 :</subfield>
            <subfield code="c">$15.95</subfield>
        </datafield>
        <datafield tag="040" ind1=" " ind2=" ">
            <subfield code="a">DLC</subfield>
            <subfield code="c">DLC</subfield>
            <subfield code="d">DLC</subfield>
        </datafield>
        <datafield tag="042" ind1=" " ind2=" ">
            <subfield code="a">lcac</subfield>
        </datafield>
        <datafield tag="050" ind1="0" ind2="0">
            <subfield code="a">PS3537.A618</subfield>
            <subfield code="b">A88 1993</subfield>
        </datafield>
        <datafield tag="082" ind1="0" ind2="0">
            <subfield code="a">811/.52</subfield>
            <subfield code="2">20</subfield>
        </datafield>
        <datafield tag="100" ind1="1" ind2=" ">
            <subfield code="a">Sandburg, Carl,</subfield>
            <subfield code="d">1878-1967.</subfield>
        </datafield>
        <datafield tag="245" ind1="1" ind2="0">
            <subfield code="a">Arithmetic /</subfield>
            <subfield code="c">
                Carl Sandburg ; illustrated as an anamorphic adventure by Ted Rand.
            </subfield>
        </datafield>
        <datafield tag="250" ind1=" " ind2=" ">
            <subfield code="a">1st ed.</subfield>
        </datafield>

    </record>
</collection>
                ]]>
            </content>
        </ingestDocument>
    </requestDocuments>
</request>

...