GetPickList schema, example, validation rules, validation stylesheet

GetPickList type: GetPickList

The purpose of the GetPickList is to enable a request for the retrieval of a single Picking List from an ERP system. The reply to this request is the ShowPickList. Individual lines from a Picking List are not selectable with this BOD. Only the complete document is selected and returned.

GetPickList extends: BusinessObjectDocument
Structure:
Elements:
Name Type Description
DataArea GetPickListDataArea

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

GetPickListDataArea extends: DataArea
Structure:
Elements:
Name Type Description
Get reference
PickList reference

GetPickList Scenario Diagram

Get schema

Get type: Get

The GET verb is to communicate to a business software component a request for an existing piece of information to be returned. The GET may be paired with most of the nouns defined in the OAGIS specification.The response to this request is the SHOW verb. The behavior of a BOD with a GET verb is quite predictable across most of the nouns it may be paired with.The GET is designed to retrieve a single piece of information by using that information's primary retrieval field, or key field. The GET verb is not used to request several documents at once. The GETLIST verb is designed to achieve that purpose and will be covered in more detail later.Selection Criteria:There are two types of selection capabilities for most BOD's that use the GET verb.1) The first selection capability is called Field-Based Selection. Within a GET-based Business Object Document, the first Data Type that occurs in a specific BOD structure is commonly used to provide the Field-Based Selection criteria. This is always defined within the specific BOD and is commonly the required fields for that specific Data type.The Field-Based Selection enables the requester to provide a value or values (in the case of multiple required Field Identifiers), in the required fields. Then the responding component uses those values to find and return the requested information to the originating business software component.2) The second type of selection capability for GET-based BODs is called Data Type Selection. Data Type selection enables the requester to identify which Data Types within the noun are requested to be returned in the response. The use of this capability is described for each corresponding Data Type for all BODs that use the GET verb. The Data Types are identified for retrieval within the GET instance of a BOD by including the name of the Data Type in the meta data but without any Field Identifiers or Segments identified within the Data Type. This will signify to the responding application that all of the data that corresponds to that Data Type is to be included in the response.If the Data Type is not requested, the Data Type identifier is not included in the GET request and this will signify to the responding component that the Data Type is not to be returned.

Get extends: RequestVerb
Structure:
Attributes:
Name Type Usage Description
show xs:string

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