Confirm

The Confirm verb is used to respond to a request to confirm the receipt of information by the receiving system. The request for confirmation is set by the sending application in the ApplicationArea\Sender\Confirmation field of the original BOD.  The Confirm conveys the result of the original request i.e. whether or not the message was understood and was successfully processed.  An example of this is Confirm BOD.

See http://www.openapplications.org/oagis/9.0.

Element information

Content

from type ResponseVerbType
Sequence [1..1]
1. OriginalApplicationArea [0..1]    A copy of the ApplicationArea for the original BOD that was processed. Present either as additional reference information, or for use in identifying the BOD in situations where a BODReference is not known.
2. ResponseCriteria [0..*]    ResponseCriteria identifies the content that is returned, given a Get query success or the response from the Process. In essence, the expression here has the effect of filtering the part(s) of the found element(s) that are to be returned. ReturnCriteria plays no role in the query itself or the process. That is handled as a match against the request BOD's noun exemplar. ReturnCriteria allows the sender of the BOD to indicate which information (down to the field level) is requested to be returned, given that the query has been successful in matching the exemplar to existing nouns. That is, in a GetListPurchaseOrder, if one or more PurchaseOrders with a TotalPrice = $1M were found, ReturnCriteria tells the BOD recipient which parts of the PurchaseOrder should be populated with content when the response (ShowPurchaseOrder) is formulated. The expressionLanguage indicates the expression language being used. In order for the ReturnCriteria expression to be evaluable by the BOD recipient, the recipient must be capable of processing and interpreting the specified expression language. XPath is the default, due to its ubiquity among XML processing technologies.

Attributes

None

Used in

• Type ConfirmBODDataAreaType (Element DataArea)

Sample instance

<Confirm>
   <OriginalApplicationArea>
      <Sender>
         <LogicalID>normalizedString</LogicalID>
         <ComponentID>normalizedString</ComponentID>
         <TaskID>normalizedString</TaskID>
         <ReferenceID>normalizedString</ReferenceID>
         <ConfirmationCode>Always</ConfirmationCode>
         <AuthorizationID>normalizedString</AuthorizationID>
      </Sender>
      <Receiver>
         <LogicalID>normalizedString</LogicalID>
         <ComponentID>normalizedString</ComponentID>
         <ID>normalizedString</ID>
      </Receiver>
      <CreationDateTime>2000-01-01</CreationDateTime>
      <Signature>
         <!--any element-->
      </Signature>
      <BODID>normalizedString</BODID>
      <UserArea>
         <!--any element-->
      </UserArea>
   </OriginalApplicationArea>
   <ResponseCriteria>
      <ResponseExpression actionCode="Accepted">token</ResponseExpression>
      <ChangeStatus>
         <Code>normalizedString</Code>
         <Description>string</Description>
         <EffectiveDateTime>2000-01-01</EffectiveDateTime>
         <ReasonCode>normalizedString</ReasonCode>
         <Reason>string</Reason>
         <StateChange>...
         </StateChange>
         <UserArea>
            <!--any element-->
         </UserArea>
      </ChangeStatus>
   </ResponseCriteria>
</Confirm>