Changes between Version 22 and Version 23 of DPWS_API_NOTES


Ignore:
Timestamp:
25/08/10 12:02:57 (9 years ago)
Author:
sdonegan
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • DPWS_API_NOTES

    v22 v23  
    178178The response should return the provider ID assigned to this provider. 
    179179 
    180 In order to update details on an existing provider this operation should also be used, but the existing ProviderID element must be filled with the assigned ProviderID value.  Any values present in the request will be used to update the provider details i.e. : 
     180In order to update details on an existing provider this operation should also be used, but the existing !ProviderID element must be filled with the assigned !ProviderID value.  Any values present in the request will be used to update the provider details i.e. : 
    181181 
    182182{{{ 
     
    281281}}} 
    282282 
    283 === !DoHarvest Operation === 
    284  
    285 The !DoHarvest operation will simply initiate a metadata harvest for a provider using the unique provider ID assigned to that provider at the time of provider details entry into the DPWS database.  The !DoHarvestRequest requires the ProviderID and optionally any number of !EmailReportID from the provider email details.  Note that the !EmailReportID element must contain the associated unique ID for the recipient in the relevant Provider details.  In the sample below, 162 is the ID assigned to Ms Upsy Daisy.  If Monitor is set to true then that email will also be notified even if no EmailReportID element is supplied. 
     283=== doHarvest Operation === 
     284 
     285The doHarvest operation will simply initiate a metadata harvest for a provider using the unique provider ID assigned to that provider at the time of provider details entry into the DPWS database.  The doHarvestRequest requires the ProviderID and optionally any number of !EmailReportID from the provider email details.  Note that the !EmailReportID element must contain the associated unique ID for the recipient in the relevant Provider details.  In the sample below, 162 is the ID assigned to Ms Upsy Daisy.  If Monitor is set to true then that email will also be notified even if no !EmailReportID element is supplied. 
    286286 
    287287[[Image(doHarvestRequest.png)]] 
     
    300300}}} 
    301301 
    302 The !DoHarvestResponse will return a status value and message as well as a unique process identifier in `processID`.  This assigned identifier is the value that must be used in subsequent !getProcessStatus and !DoIngest operations. 
     302The doHarvestResponse will return a status value and message as well as a unique process identifier in `processID`.  This assigned identifier is the value that must be used in subsequent getStatusProcess and doIngest operations. 
    303303 
    304304[[Image(doHarvestResponse.png)]] 
     
    322322}}} 
    323323 
    324 === !DoIngest Operation === 
    325  
    326 A 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. 
     324=== doIngest Operation === 
     325 
     326A 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 getStatusProcess operation has verifed that the harvest has completed. 
    327327 
    328328[[Image(doIngestRequest.png)]] 
     
    342342}}} 
    343343 
    344 Note that the processID to ingest is supplied as the value for attribute "id" in ProcessID. 
     344Note that the processID to ingest is supplied as the value for attribute "id" in !ProcessID. 
    345345 
    346346The response will be a simple confirmation that the ingest request has been recieved. 
     
    363363}}} 
    364364 
    365 === !GetProcessStatus Operation === 
    366  
    367 The 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. 
     365=== getStatusProcess Operation === 
     366 
     367The 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. 
    368368 
    369369[[Image(getStatusProcessRequest.png)]] 
    370370 
    371 The GetProcessStatusRequest requires simple the processID as input and the GetProcessStatusResponse will return 
     371The getStatusProcessRequest requires simple the processID as input and the getStatusProcessResponse will return 
    372372 
    373373{{{ 
     
    404404There 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". 
    405405 
    406 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 an "end" status.  At this stage the DPP can issue a GetHarvestHistoryRequest or GetIngestHistoryRequest. 
    407  
    408 === !GetHarvestHistory Operation === 
    409 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.  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.  A date range is optional - if this is not supplied then all harvest history records are returned. 
     406In 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. 
     407 
     408=== getHarvestHistory Operation === 
     409 
     410The DPP should perform the GetHarvestHistory operation once a getStatusProcess 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.  A date range is optional - if this is not supplied then all harvest history records are returned. 
    410411 
    411412[[Image(getHarvestHistoryRequest.png)]] 
     
    477478 
    478479 
    479 === !GetIngestHistory Operation === 
    480 The DPP should perform the !getIngestHistory operation once a !getStatusProcess 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.  This operations works in a similar manner to the getHarvestHistory operation- just supply the providerID and a data range if required.  If not data range is supplied the entire ingest history for that provider is returned.  If no providerID is supplied the entire ingest history for all providers is returned. 
     480=== getIngestHistory Operation === 
     481 
     482The DPP should perform the getIngestHistory operation once a getStatusProcess 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.  This operations works in a similar manner to the getHarvestHistory operation- just supply the providerID and a data range if required.  If not data range is supplied the entire ingest history for that provider is returned.  If no providerID is supplied the entire ingest history for all providers is returned. 
    481483 
    482484