Recommended Reading:
ListPurchaseOrder
In an effort to simpilify the usage of the verbs the ListPurchaseOrder BOD is being deprecated as of OAGIS 9.0, the ListPurchaseOrder will still be provided for the next three releases at which time it is scheduled to be removed from OAGIS. As such for all new development we recommend that you use the ShowPurchaseOrder BOD which may serve the same function of the ListPurchaseOrder BOD. The purpose of the List PurchaseOrder is to send information relative to demand for goods or services to another business application. This may be in response to a GetList PurchaseOrder request, or it may be a notification vehicle, initiated upon an event in a business application. The List verb describes the behavior of supplying one or several documents in a summary format to the requesting business application. These listings of information may be supplied for Purchase Orders, PO Lines, or PO Sub-Lines. This BOD usually does not cause updates to occur and may be used as part of a larger integration scenario or as a single tool for communicating demand. There are many possible business applications in several environments that may use this capability. For example: 1. A PO application could use this BOD to send information to a Plant Data Collection application. 3. A MRP, Inventory or Manufacturing business application could use this to obtain order information.
See http://www.openapplications.org/oagis/9.
Element information
Namespace: http://www.openapplications.org/oagis/9
Schema document: org_openapplications_oagis/9_4_1/Developer/BODs/ListPurchaseOrder.xsd
Type: ListPurchaseOrderType
Properties: Global, Qualified
Content
- Sequence
[1..1]
- ApplicationArea [1..1] Provides the information that an application may need to know in order to communicate in an integration of two or more business applications. The ApplicationArea is used at the applications layer of communication. While the integration frameworks web services and middleware provide the communication layer that OAGIS operates on top of.
- DataArea [1..1] Is where the information that the BOD message carries is provided, in this case ListPurchaseOrder. The information consists of a Verb and one or more Nouns. The verb (List) indicates the action to be performed on the Noun (PurchaseOrder).
from type BusinessObjectDocumentType
Attributes
| Name | Occ | Type | Description | Notes |
|---|---|---|---|---|
| releaseID | [1..1] | NormalizedStringType | OAGIS Release this BOD Instances belongs or the OAGIS release that the derivative work is based on. | from type BusinessObjectDocumentType |
| versionID | [0..1] | NormalizedStringType | Indicates the version of the given BOD definition. | from type BusinessObjectDocumentType |
| systemEnvironmentCode | [0..1] | SystemEnvironmentCodeContentType | Indicates whether this BOD is being sent in a "Test" or a "Production" mode. If the BOD is being sent in a test mode, it's information should not affect the business operation. However, if the BOD is sent in "Production" mode it is assumed that all test has been complete and the contents of the BOD are to affect the operation of the receiving business application(s). | Default value is "Production". from type BusinessObjectDocumentType |
| languageCode | [0..1] | LanguageCodeContentType | Indicates the language that the contents of the BOD is in unless otherwise stated. | Default value is "en-US". from type BusinessObjectDocumentType |
Used in
- Type OAGIS9BODsType (Element OAGIS9BODs)
Sample instance
<ListPurchaseOrder releaseID="normalizedString"> <ApplicationArea> <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> </ApplicationArea> <DataArea> <List> <OriginalApplicationArea>... </OriginalApplicationArea> <ResponseCriteria>... </ResponseCriteria> </List> <PurchaseOrder> <PurchaseOrderHeader>... </PurchaseOrderHeader> <PurchaseOrderLine>... </PurchaseOrderLine> </PurchaseOrder> </DataArea> </ListPurchaseOrder>