GetListProductionOrder schema, example, validation rules, validation stylesheet

GetListProductionOrder type: GetListProductionOrder

The purpose of the GetListProductionOrder is to enable an business software component to request summary Production Order information from another business application module. The response to this request is the ListProductionOrder. The GetListProductionOrder also enables the retrieval of information across several documents by using selection fields. An example of this could be requesting all ProductionOrder 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.

GetListProductionOrder extends: BusinessObjectDocument
Structure:
Elements:
Name Type Description
DataArea GetListProductionOrderDataArea

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

GetListProductionOrderDataArea extends: DataArea
Structure:
Elements:
Name Type Description
GetList reference
ProductionOrder reference

GetListProductionOrder 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

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