GetListPickList schema, example, validation rules, validation stylesheet

GetListPickList type: GetListPickList

The purpose of the GetListPickList is to enable a business application to request summary information for one or more Picking Lists from an ERP system. If a List of documents is requested, that list will be used so a selection and Get request of a specific picking list can be made, if necessary.

GetListPickList extends: BusinessObjectDocument
Structure:
Elements:
Name Type Description
DataArea GetListPickListDataArea

Is where the information that the BOD message carries is provided, in this case GetListPickList. The information consists of a Verb and one or more Nouns. The verb (GetList) indicates the action to be performed on the Noun (PickList).

GetListPickListDataArea extends: DataArea
Structure:
Elements:
Name Type Description
GetList reference
PickList reference

GetListPickList Scenario Diagram

GetList schema

GetList type: GetList

The purpose of the GetList verb is to enable a business software component to request summary information for one or more occurrences of a specific noun from another business software component. The GetList may be paired with most of the nouns in the OAGIS specification.The response to this request is a BOD using the List verb. The GetList is designed to retrieve multiple occurrences of data such as all of the sales orders or all of the purchase orders within a requested range. It does not require an exact match of the key fields in order to retrieve information. It may use a range selection criteria with a "from" and "to" selection capability. This behavior is quite different from the Get verb, which is designed to retrieve a specific noun using a specific key field.The GetList verb also enables the retrieval of information across several documents by using selection fields. An example of this could be requesting all sales order lines for a specific item. This type of functionality is limited to the capabilities of the responding application and needs to be determined during the implementation project. More details on this capability will be described below. GetList attributes: o maxitems attribute is a number that indicates the number of maximum items to be returned. o rssave attribute is a Boolean flag that indicates whether the result set should be saved on the sending system if maxitems is exceeded. o rsstart attribute is a number of the starting record for the next section of the result set. If it is omitted, it is to be assumed the first of the maxitems. o rsref attribute is a string that represents the implementation-specific result set identifier for subsequent requests. Selection Criteria: There are two types of selection capabilities enabled by the BODs that use the GetList verb. 1) Field-Based Selection Allows the requesting system to ask for information that matches the data provided. It also allows the requestor to indicate the information that to be returned by specifying the ReturnCriteria indicated on the GetList Verb. 2) Range Selection Allows the requesting system to provide a range of values for known data. This is accomplished by providing two occurances of the Noun. The first occurance indicates the "From" the second occurance indicates the "To" occurance. Again the requestor can indicate the information that to be returned by specifying the ReturnCriteria indicated on the GetList Verb.

GetList extends: RequestVerb
Structure:
Attributes:
Name Type Usage Description
list xs:string optional
maxItems xs:positiveInteger optional
rsRef xs:string optional
rsSave xs:boolean optional
rsStart xs:positiveInteger optional

PickList schema

PickList type: PickList

Picking List is a document that lists material to be retrieved (“picked”) from various locations in a warehouse in order to fill a production order, sales order, or shipping order. A picking list includes general identifying information (header information), as well as line item details. Depending on the verb used, PickList may refer to header information only, or both header and detail information.

Header type: PickListHeader

Information about the entire Picking List

Line type: PickListLine

Information about a line item on a Picking List.

Detail type: PickLineDetail

Detail information about particular line items

PickLineDetail

Describes further details about a line item on a Picking List document that is generated in an ERP shipping module.

Structure:
Elements:
Name Type Description
LoadingDateTime DateTime

Is the timestamp when the items are loaded.

LoadPointId Id

Identifies the location that shipped goods are to be loaded.

Generic identifier type with open qualifyingAgency.

MaterialVolume Quantity

Is the volume of the material.

A decimal value.

MaximumContainerWeight Quantity

Is the maximum weigth that the container can hold.

A decimal value.

NetContainerWeight Quantity

Is the net container weight.

A decimal value.

NetMaterialWeight Quantity

Is the net weight of the material being picked.

A decimal value.

ShippedDateTime DateTime

Is the timestamp that indicates when the PickList shipped.

ShippingMaterial reference

Description of the packaging

ShipPointId Id

Identifies the Shipping location that a PickList is to be shipped.

Generic identifier type with open qualifyingAgency.

TotalMaterialWeight Quantity

Total weight of the material being picked.

A decimal value.

TrackingId Id

Is a unique identifier for the purpose of tracking an individual package or shipment.

Generic identifier type with open qualifyingAgency.

UserArea reference

PickList extends: Noun
Structure:
Elements:
Name Type Description
Header reference
Line reference

PickListHeader

Information about the entire Picking List

Structure:
Elements:
Name Type Description
BillOfLadingId Id

Is the bill of lading identifier.

Generic identifier type with open qualifyingAgency.

DockId Id

Idenitifies the loading dock that the picklist is to be taken to for shipment or is coming from.

Generic identifier type with open qualifyingAgency.

DocumentDateTime DateTime
DocumentId reference
Parties reference

SAT - What is this for PARTNRID in header? need to check with duane

RouteId Id

Is an identifier than identifies the physical route the shipped material is taking.

Generic identifier type with open qualifyingAgency.

ShipPoint Id

Identifies the location the goods are to be shipped.

Generic identifier type with open qualifyingAgency.

UserArea reference
Volume Quantity

Total volume of the PickList.

A decimal value.

Weight Quantity

Total weight of the PickList.

A decimal value.

PickListLine
Structure:
Elements:
Name Type Description
CarrierReference reference
Detail reference
Item reference
LineNumber LineNumber

Is the line number of the PickList.

Identifies the instance of a Line within a given document.

PickQuantity Quantity

Is the Quantity to Pick.

A decimal value.

ShippedQuantity Quantity

Is the quantity that is shipped against the picklist

A decimal value.

ShipUnitQuantity Quantity

This represents the container(s), not the product shipped. An example of this is “4 truck loads” or “2 wooden crates”.

A decimal value.

UserArea reference

Verb Common Files

Verb.xsd schema

AcknowledgableVerb extends: ConfirmableVerb
Structure:
Attributes:
Name Type Usage Description
acknowledge AcknowledgementType

AcknowledgementType restricts: xs:NMTOKEN
Enumerations:
Always
Never
OnChange

ConfirmableVerb extends: Verb
Structure:
Attributes:
Name Type Usage Description
confirm ConfirmType

ConfirmType restricts: xs:NMTOKEN
Enumerations:
Always
Never
OnChange

Expression restricts: xs:string

ExpressionCriteria
Structure:
Elements:
Name Type Description
SelectExpression Expression

Allows the 1-n number of selection expressions for the information to be returned.

Attributes:
Name Type Usage Description
expressionLanguage xs:string optional

RequestVerb extends: ConfirmableVerb
Structure:
Elements:
Name Type Description
ReturnCriteria

Allows the initator of the BOD to indicate the information (down to the field level) that is requested to be returned. The expressionLanguage indicates the expression language being used.

VerbBase.xsd schema

Verb type: Verb

Verb
Structure:

Noun Common Files