Changes between Version 10 and Version 11 of DPWS_API_NOTES


Ignore:
Timestamp:
25/08/10 10:29:45 (9 years ago)
Author:
sdonegan
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • DPWS_API_NOTES

    v10 v11  
    340340The 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. 
    341341 
     342[[Image(getStatusProcessRequest.png, 400px)]] 
     343 
    342344The GetProcessStatusRequest requires simple the processID as input and the GetProcessStatusResponse will return 
    343345 
    344 In order to monitor the current status of a certain operation, the DPP will need to recursively perform a GetStatusProcesses operation until the DPWS returns a status “completed”.  At this stage the DPP can issue a GetHarvestHistoryRequest or GetIngestHistoryRequest. 
     346{{{ 
     347<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> 
     348    <SOAP-ENV:Header/> 
     349    <SOAP-ENV:Body> 
     350        <getStatusProcess xmlns="http://ejb.revitalization.services.ndg/"> 
     351            <request xmlns=""> 
     352                <ProcessID xmlns="http://ejb.revitalization.services.ndg/">430</ProcessID> 
     353            </request> 
     354        </getStatusProcess> 
     355    </SOAP-ENV:Body> 
     356</SOAP-ENV:Envelope> 
     357}}} 
     358 
     359[[Image(getStatusProcessResponse.png, 400px)]] 
     360 
     361{{{ 
     362<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"> 
     363    <env:Header/> 
     364    <env:Body> 
     365        <ns1:getStatusProcessResponse xmlns:ns1="http://ejb.revitalization.services.ndg/"> 
     366            <return> 
     367                <ns1:Confirmation> 
     368                    <ns1:Status>OK</ns1:Status> 
     369                </ns1:Confirmation> 
     370                <ns1:ProcessID ns1:status="end_ingest" ns1:id="430"/> 
     371            </return> 
     372        </ns1:getStatusProcessResponse> 
     373    </env:Body> 
     374</env:Envelope> 
     375}}} 
     376 
     377There are 3 values available for the status of the doHarvest operation: start_harvest; run_harvest; end_harvest.  Likewise, the are 3 status values for the doIngest operation: start_ingest; run_ingest; end_ingest.  These values are supplied in the status attribute of the ProcessID element in the getStatusProcessResponse.  The doIngest operation must only be called once the doHarvest status is "end_harvest". 
     378 
     379In 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. 
    345380 
    346381=== !GetHarvestHistory ===