Changes between Version 12 and Version 13 of DPWS_API_NOTES


Ignore:
Timestamp:
25/08/10 10:42:36 (9 years ago)
Author:
sdonegan
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • DPWS_API_NOTES

    v12 v13  
    296296}}} 
    297297 
    298 === !DoIngest === 
     298=== !DoIngest Operation === 
    299299 
    300300A metadata ingest into the Discovery database for a particular provider is acheived by simply supplying the !ProcessID returned in the !DoHarvestResponse resulting from a previous !DoHarvestRequest for the specified provider.  Like the !DoHarvestRequest an !EmailReportID can be supplied to which process completion reporting messages can be sent if the user wishes.  The doIngest operation must only be called on a processID once the getProcessStatus operation has verifed that the harvest has completed. 
     
    337337}}} 
    338338 
    339 === !GetProcessStatus === 
     339=== !GetProcessStatus Operation === 
     340 
    340341The system of metadata harvesting and ingestion can take long periods to complete, especially when large numbers of records are involved and there is heavy traffic on the hardware systems employed at CEDA.  As the metadata harvest needs to fully complete before ingestion takes place the GetStatusProcess operations allow the client to determine when it is possible to continue with further operations on a specific processID.  This includes GetHarvestHistory and GetIngestHistory operations. 
    341342 
     
    379380In order to monitor the current status of a certain operation, the DPP will need to recursively perform a GetStatusProcesses operation until the DPWS returns an "end" status.  At this stage the DPP can issue a GetHarvestHistoryRequest or GetIngestHistoryRequest. 
    380381 
    381 === !GetHarvestHistory === 
    382 The DPP should perform the GetHarvestHistory operation once a GetStatus has affirmed the processID completion.  The DPP should use this operation to either download and synchronise the local sqlLite db contents or render the information directly on the DPP front end. 
    383  
    384  
    385 === !GetIngestHistory === 
     382=== !GetHarvestHistory Operation === 
     383The DPP should perform the GetHarvestHistory operation once a GetStatus has affirmed the processID completion.  The DPP should use this operation to either download and synchronise the local sqlLite db contents or render the information directly on the DPP front end.  When this operation is called with a providerID it will return just the history for that provider.  If no providerID is supplied in the request the response will return the harvest history for all providers. 
     384 
     385[[Image(getHarvestHistoryRequest.png, 400px)]] 
     386 
     387{{{ 
     388<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> 
     389    <SOAP-ENV:Header/> 
     390    <SOAP-ENV:Body> 
     391        <getHarvestHistory xmlns="http://ejb.revitalization.services.ndg/"> 
     392            <request xmlns=""> 
     393                <ProviderID xmlns="http://ejb.revitalization.services.ndg/">101</ProviderID> 
     394            </request> 
     395        </getHarvestHistory> 
     396    </SOAP-ENV:Body> 
     397</SOAP-ENV:Envelope> 
     398}}} 
     399 
     400[[Image(getHarvestHistoryRequest.png, 400px)]] 
     401 
     402{{{ 
     403<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"> 
     404    <env:Header/> 
     405    <env:Body> 
     406        <ns1:getHarvestHistoryResponse xmlns:ns1="http://ejb.revitalization.services.ndg/"> 
     407            <return> 
     408                <ns1:Confirmation> 
     409                    <ns1:Status>OK</ns1:Status> 
     410                </ns1:Confirmation> 
     411                <ns1:HarvestingEvent> 
     412                    <ns1:RequestId>400</ns1:RequestId> 
     413                    <ns1:TotalRecords>157</ns1:TotalRecords> 
     414                    <ns1:HarvestStartTime>2010-08-24T10:15:43.393+01:00</ns1:HarvestStartTime> 
     415                    <ns1:HarvestStopTime>2010-08-24T10:15:56.883+01:00</ns1:HarvestStopTime> 
     416                    <ns1:ProviderID>101</ns1:ProviderID> 
     417                </ns1:HarvestingEvent> 
     418                <ns1:HarvestingEvent> 
     419                    <ns1:RequestId>410</ns1:RequestId> 
     420                    <ns1:TotalRecords>157</ns1:TotalRecords> 
     421                    <ns1:HarvestStartTime>2010-08-24T11:47:53.009+01:00</ns1:HarvestStartTime> 
     422                    <ns1:HarvestStopTime>2010-08-24T11:47:57.693+01:00</ns1:HarvestStopTime> 
     423                    <ns1:ProviderID>101</ns1:ProviderID> 
     424                </ns1:HarvestingEvent> 
     425                <ns1:HarvestingEvent> 
     426                    <ns1:RequestId>420</ns1:RequestId> 
     427                    <ns1:TotalRecords>157</ns1:TotalRecords> 
     428                    <ns1:HarvestStartTime>2010-08-24T11:51:32.199+01:00</ns1:HarvestStartTime> 
     429                    <ns1:HarvestStopTime>2010-08-24T11:51:40.124+01:00</ns1:HarvestStopTime> 
     430                    <ns1:ProviderID>101</ns1:ProviderID> 
     431                </ns1:HarvestingEvent> 
     432                <ns1:HarvestingEvent> 
     433                    <ns1:RequestId>421</ns1:RequestId> 
     434                    <ns1:TotalRecords>157</ns1:TotalRecords> 
     435                    <ns1:HarvestStartTime>2010-08-24T11:54:25.699+01:00</ns1:HarvestStartTime> 
     436                    <ns1:HarvestStopTime>2010-08-24T11:54:38.633+01:00</ns1:HarvestStopTime> 
     437                    <ns1:ProviderID>101</ns1:ProviderID> 
     438                </ns1:HarvestingEvent> 
     439                <ns1:HarvestingEvent> 
     440                    <ns1:RequestId>430</ns1:RequestId> 
     441                    <ns1:TotalRecords>157</ns1:TotalRecords> 
     442                    <ns1:HarvestStartTime>2010-08-24T16:49:18.444+01:00</ns1:HarvestStartTime> 
     443                    <ns1:HarvestStopTime>2010-08-24T16:49:28.421+01:00</ns1:HarvestStopTime> 
     444                    <ns1:ProviderID>101</ns1:ProviderID> 
     445                </ns1:HarvestingEvent> 
     446            </return> 
     447        </ns1:getHarvestHistoryResponse> 
     448    </env:Body> 
     449</env:Envelope> 
     450}}} 
     451 
     452 
     453=== !GetIngestHistory Operation === 
    386454The DPP should perform the GetIngestHistory operation once a GetStatus has affirmed the processID completion.  The DPP should use this operation to either download and synchronise the local sqlLite db contents or render the information directly on the DPP front end. 
    387455