Witsml/> Core Application Program Interface Version 1
PUBLISH Interface Example
Download 0.54 Mb.
|
- Navigate this page:
- 13 APPENDIX E - Service Agreement
- 14 APPENDIX F - Custom Data
- 14.1Namespace
12.5PUBLISH Interface ExampleJust as the STORE interface has special handling of Query Templates for the growing objects, the PUBLISH interface also has special handling of Subscription Templates for these objects. That is, a Subscription Template can - like a Query Template - specify a range of values that determine which occurrences of a recurring structure are to be returned. A Subscription Template for the log object, for example, can specify a begin and end depth and only the log data points falling within that range will be published. Both Query and Subscription Templates specify the type of object to be returned (well, wellbore, etc), the data items to be returned (elements and attributes), which objects are to be returned (by specifying a value of one or more data items) and - for those objects having special handling - the range of recurring structure occurrences to be returned. For the STORE interface, that is the extent of the "selection" process; the Query Template fully specifies the object types, instances and contents to be returned. And, for most data objects, the Subscription Template also fully specifies the object types and contents to be sent to a Subscriber by the Publisher. ► However, for the growing objects, the PUBLISH interface also performs additional "eligibility" processing prior to applying the Subscription Template. As described in the section on Publishing, a Publisher considers an object to be "eligible" to be sent to a Subscriber only when that object has changed (or been newly-added). But some objects "grow" over time as additional occurrences of their recurring structures are added (as additional trajectoryStations are added to a trajectory object, for instance), and thus the Publisher might publish the entire object each time a new recurring structure was inserted! To prevent this needless retransmission of data, the Publisher always considers the non-recurring ("header") data items of the log, mudLog and trajectory objects to be eligible for publication, but only considers those instances of the recurring structure that are new or have been changed to be eligible for publication. Here's a summary of the parts of growing objects that are eligible to be published, based on the type of change: Type of Change Eligible for Publication new object all non-recurring data and
all instances of recurring structure update of non-recurring data all non-recurring data add of new recurring data all non-recurring data and
new instance(s) of recurring structure update of existing recurring data all non-recurring data and
updated instance(s) of recurring structure Once the Publisher has determined which part of these objects are eligible for publication, it then applies the Subscription Template to determine whether the Subscriber has requested this particular object (and which portions of the object). 
► The Subscription Template is applied to the parts of the object that are eligible to be published in the same way as a Query Template - including special handling. 13 APPENDIX E - Service AgreementWhenever a WITSML service is setup between a WITSML service provider (provider) and a WITSML service consumer (consumer) there are several aspects of the service that needs to be further specified and agreed upon. The WITSML standard only contains specifications about the data transport media, format, protocol, data objects and their elements, and so the issues below are not part of the standard itself. In order for a WITSML service to be successfully setup, the provider and consumer also needs to agree on these subjects:
14 APPENDIX F - Custom DataAll the WITSML data objects include a container element named For the special case of The following recommendations are made in order to minimize problems across different implementations of custom data.
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" … WITSML-defined elements and attributes … 1 for example, the Subscriber will convey in its capabilities object the version of the API that it implements. This will allow new versions of the API to be implemented without disrupting existing systems. 2 because HTTP/S is used to transport the published data, this use case shows the Subscriber process running under a generic HTTP/S Server (aka, “web server”). A Subscriber is free to implement its own dedicated, embedded HTTP/S processing if it wishes. 3 XML is not sensitive to “white space” characters such as line feeds, so reformatting it this way doesn’t affect its meaning. 4 but this can be accomplished in two steps – see the next page. 5 the Subscription object cannot specify the Subscription or Capabilities object types, however. Those object types cannot be published. 6 for a more rigorous definition of HTTP syntax, see http://www.w3.org/Protocols/rfc2616/rfc2616.html 7 additional spaces have been inserted into the example elements to make the example more easily readable. Spaces would not be present between numeric values in actual elements. 8 Since the Bit RPM curve in the example contains data only up to interval 4070, this query will result in null values being returned for the Bit RPM curve in the intervals above 4070. Directory: schema schema -> Recommended list of diagrams for the Anatomy final examination Skeleton, joints, muscles schema -> Schema/Assimilation/Accommodation Schema schema -> Resume: exhibitions schema -> B2b web Service Guidelines V2 rsvz enterprise Architecture schema -> State of Maine-Sample Automobile Lifts and Hoists Schema-Sample schema -> Outline of Critique Of Pure Reason Download 0.54 Mb. Share with your friends:
|