GetProductAvailability schema, example, validation rules, validation stylesheet

GetProductAvailability type: GetProductAvailability

The purpose of the GetProductAvailability is to enable requests of product availability data by an Order Management business application to an Available to Promise (ATP) or Production business application. The business process scenario is the Order Management application interacting with the Available to Promise or Production application in order to determine availability of a product for the customer. This scenario is commonly referred to as Make to Order or Build to Order. The response to this request is the ShowProductAvailability.

GetProductAvailability extends: BusinessObjectDocument
Structure:
Elements:
Name Type Description
DataArea GetProductAvailabilityDataArea

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

GetProductAvailabilityDataArea extends: DataArea
Structure:
Elements:
Name Type Description
Get reference
ProductAvailability reference

GetProductAvailability 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

ProductAvailability schema

ProductAvailability

Product Availability represents information on the availability of a specified item at a specified inventory location for a specified date. Product availability is typically needed in the processing of customer sales orders. It is used in this context as the object of an inquiry function.

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

ProductRequirementBase.xsd schema

ProductRequirementBase extends: Noun

This is a base type that is used for any Product Requirement or Availability scenarios

Structure:
Elements:
Name Type Description
AvailableDateTime DateTime
Business reference
DocumentReferences reference
EffectiveDateTime DateTime
GLEntity GLEntity

Is the GLEntity that owns the items now.

The primary balancing segment of the G/L Account structure. P and L statements are required at this level. A G/L entity is the smallest organizational unit for which individual financial statements must be drawn up according to relevant commercial law.

Synonyms: Business Unit, Fund, General Ledger Company, Joint Venture, Non-Profit Association Name

Item reference
ItemQuantity Quantity

A decimal value.

Note reference

A free form note. The lang attribute identifies the language that the note is in. The author identifies the author of the note. The enrtyDate indicates the date the note was entered or last modified.

ProductLine ProductLine

This is a grouping used to represent something that is sold either internally or externally. It typically is a grouping of ITEMs. SYNONYMS: Commodity Product Family Kit

Categorization used to represent something that is sold either internally or externally. It typically is a grouping of ITEMs.PRODCTLINE replaces PRODUCT.SYNONYMS§ Commodity§ Product Family§ Kit

RequiredDateTime DateTime
Site reference

Identifies the location in which the Items are currently located.

SubstitutionAllowedInd Indicator

Indicates whether or not the Order Item can be substituted with a similar item.

Indicates if the semantic name is needed or not.

UserArea reference