Versions Compared

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.1 Sending the request

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

Method: POST

Parameters:

                  docAction=ingestContent

...

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>

...

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>

...

2.3.1 Sending the request

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

Method: POST

Parameters:

                  docAction=checkIn

...

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>
		See section "Sample Input XML for Check          type="bibliographic" format="marc">
            <content>
		See section "Sample Input XML for Check in".
	<in".
	</content>
        </ingestDocument>
    </requestDocuments>
</request>

...

            Information about the response from the service for the given request 

No Format
 <?xml version="1.0" encoding="UTF-8"?>
<OLEDocstore-call>
	<request>
		<command>Check-in</command>
		<params/>
	</request>
	<response>
		<status>Success</status>
		<message>Successfully checked in </message>
	</response>
</OLEDocstore-call><response>
  <documents>
    	<document id="1" category="work" type="bibliographic" format="marc">
      	    <uuid>10000004</uuid>
	</document>
   </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

...

2.5.1 Sending the request

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

Method: POST

Parameters:

                  docAction=delete or deleteWithLinkedDocs

...

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

...

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

...

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

Go to http://localhost:8080/oledocstore/dev.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.

...

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.

...

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:

...