Chapter 5. Verbs

Table of Contents

Acknowledge
Fields and Components
Sample XML
Get
Fields and Components
Sample XML
Process
Fields and Components
Sample XML
Show
Fields and Components
Sample XML
Sync
Fields and Components
Sample XML
ActionCriteria
Fields and Components
Sample XML
ActionExpression
Fields and Components
Sample XML
Expression
Fields and Components
Sample XML
OriginalApplicationArea
ResponseCriteria
Fields and Components
Sample XML
ResponseExpression
Fields and Components
Sample XML
ChangeStatus
Fields and Components
Sample XML
StateChange
Fields and Components
Sample XML

Acknowledge

Uses the Component: AcknowledgeType

The Acknowledge verb is used to acknowledge the application receipt of a Process request. This function conveys the result of the original request. An example of this is Acknowledge PO, where a Process PO has been issued and the corresponding business application acknowledges the receipt of the PO and responds with an acceptance or a counter offer.

Fields and Components

Table 5.1. Fields and Components

Name Description Occurrence Type Data Type User Notes
OriginalApplicationArea

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.

0..1ComponentApplicationAreaType 
ResponseCriteria

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.

0..*ComponentResponseActionCriteriaType 

Sample XML

The XML Sample provided here is an approximation of the generated XML for this component. Not all of the fields are required for implementation.

Example 5.1. Acknowledge

<Acknowledge>
     <OriginalApplicationArea>......</OriginalApplicationArea>     [0..1]
     <oagis:ResponseCriteria>......</oagis:ResponseCriteria>     [0..*]
</Acknowledge>