ListPickList
In an effort to simpilify the usage of the verbs the ListPickList BOD is being deprecated as of OAGIS 9.0, the ListPickList 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 ShowPickList BOD which may serve the same function of the ListPickList BOD. The purpose of the ListPickList is to provide a list of Picking Lists from an ERP system to another application. This BOD may be initiated in response to a GetListPickList request or upon some business event. When a receiving application receives this BOD, the information can be used as is or it may be used to initiate a selection of a specific PickList through the GetPickList request. The processing is designed to provide multiple occurrences of summary data. This BOD will not usually cause updates to occur.
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/ListPickList.xsd
Type: ListPickListType
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 ListPickList. The information consists of a Verb and one or more Nouns. The verb (List) indicates the action to be performed on the Noun (PickList).
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
<ListPickList 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> <PickList> <PickListHeader>... </PickListHeader> <PickListLine>... </PickListLine> </PickList> </DataArea> </ListPickList>