GetProductionOrder schema, example, validation rules, validation stylesheet

GetProductionOrder type: GetProductionOrder

The purpose of the GetProductionOrder is to enable an business application module to request specific Production Order information from another business application module. The reply to this is the ShowProductionOrder.

GetProductionOrder extends: BusinessObjectDocument
Structure:
Elements:
Name Type Description
DataArea GetProductionOrderDataArea

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

GetProductionOrderDataArea extends: DataArea
Structure:
Elements:
Name Type Description
Get reference
ProductionOrder reference

GetProductionOrder 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

ProductionOrder schema

ProductionOrder type: ProductionOrder

Production Order is a document requesting the manufacture of a specified product and quantity.

Header type: ProductionOrderHeader

Information used to communicate the details of the production order requested to be initiated.

Line type: ProductionOrderLine

Information used to communicate the individual items on the pre-determined Bill of Material structure.

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

ProductionOrderHeader

The LOTSERIAL in the header specifies the lot and/or serial information about the final assembly defined in this production order

Structure:
Elements:
Name Type Description
Attachments reference
AvailableDateTime DateTime

Is the datetime that the items from the production order are available.

BOMDocumentReference reference
Description Description

Description of the production order.

Free-form text description of the Noun or Componenet in which the description occurs. The lang attribute indicates the language the description is in. Owner inidcates the user or entity that provided teh description..

DestinationCountry Country

Indicates the country that the item being manufactured is destinated to go to.

Standard values from ISO 3166-3:1999 Part 1

Codes for the representation of names of countries and their subdivisions - Part 1: Country codes

Distribution reference

A distribution identifies how monetary amounts are distributed accross an organization.

DocumentDateTime DateTime

Is the timestamp that the production order was originally created.

DocumentId ProductionOrderIdType

Is the ProductionOrder Identifier

DocumentReferences reference
DueDateTime DateTime

Is the datetime that the order is due.

DueQuantity Quantity

Is the quantity that is due.

A decimal value.

ForecastedTimePeriod TimePeriod

TimePeriod indicating the forecasted start and finish datetimes.

Item reference
Kanban Kanban

Is the reference number associated with in-plant routing information.

Is the reference number associated with in-plant routing information.

LotSerial reference
NeedDeliveryDateTime DateTime

Is the timestamp indicating the date and time that the items need be delivered to the customer.

Note Note

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.

OperationReference reference
OrderQuantity Quantity

Is the quantity ordered.

A decimal value.

OriginationCountry Country

Indicates the country of origin of the item.

Standard values from ISO 3166-3:1999 Part 1

Codes for the representation of names of countries and their subdivisions - Part 1: Country codes

Parties reference
Priority Priority

Is the priority of the production order.

ProductionTimePeriod TimePeriod

The TimePeriod indicating the start and finish times of the production order run.

ReasonCode ReasonCode

Is the reason for the production order.

Used as a reason indicator for any type of business event or activity.

RequiredDateTime DateTime

Is the datetime that the production order is required to run.

Site reference
Status reference
Type reference
UserArea reference

ProductionOrderLine

The LOTSERIAL in the line specifies the lot and/or serial information about the individual items on the pre-determined Bill of Material structure

Structure:
Elements:
Name Type Description
Attachments reference
Distribution reference

A distribution identifies how monetary amounts are distributed accross an organization.

Item reference
ItemQuantity Quantity

Is the quantity of items produced.

A decimal value.

LineNumber LineNumber

Is the LineNumber of the ProductionOrder Line

Identifies the instance of a Line within a given document.

LotSerial reference
OrderQuantity Quantity

Is the quantity ordered.

A decimal value.

Site reference
TrackingIndicator Indicator

Indicates that the item is to be tracked.

Indicates if the semantic name is needed or not.

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