GetListBillOfMaterial schema, example, validation rules, validation stylesheet

GetListBillOfMaterial type: GetListBillOfMaterial

The purpose of the GetListBillOfMaterial is to enable an application or component to request a summary list of Bill of Material information from another business application or component. The response to the GetListBillOfMaterial is the ListBillOfMaterial The GwtListBillOfMaterial also enables the retrieval of information across several documents by using selection fields. An example of this could be requesting all Bills of Material 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. There are many possible business applications in several environments that may use this capability. For example, an MRP, Inventory, or Manufacturing business application could use this to communicate Item Bill of Material information.

GetListBillOfMaterial extends: BusinessObjectDocument
Structure:
Elements:
Name Type Description
DataArea GetListBillOfMaterialDataArea

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

GetListBillOfMaterialDataArea extends: DataArea
Structure:
Elements:
Name Type Description
BillOfMaterial reference
GetList reference

GetListBillOfMaterial 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

BillOfMaterial schema

BillOfMaterial type: BillOfMaterial

When included in a hierarchy, the Components are position dependent for their meaning and applicability to the Bill of Material. The Bill of Material structure is broken down into three classifications or ways to represent the Item. An Item may be included by itself as in the first sub-grouping, or an Item may be represented as part of a set of options or as an option within a class of options. An example of an option would be CD-ROM for a laptop computer. Then each of the types of CD-ROM’s for the option would be a separate Item. An example of an option class would be memory for a laptop. The options could then be 128, 256, or 512 megabytes of RAM. Each of these options would then have separate Item identifiers for memory modules that makes up the appropriate amount of memory. For 256 megabytes of RAM, this could be two 128 megabyte memory modules or one 256 megabyte.

Header type: BillOfMaterialHeader

Information that generally describes the Bill of Material Structure and it’s contents.

Option type: Option

Information that describes the attributes of a specific Option within a classification.

OptionClass type: OptionClass

Information that describes the class of Option for a particular Product or Item

BillOfMaterial extends: Noun

Structure:
Elements:
Name Type Description
Header reference
ItemData reference
Option reference
OptionClass reference

BillOfMaterialHeader
Structure:
Elements:
Name Type Description
AlternateBOM BOMDocumentReference

Identifies Alternate BOM for the given BOM.

BatchSizeQuantity Quantity

Identifies the number of items that can be produced in each run of the BOM.

A decimal value.

Description Description

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..

DocumentId PartyGenericIdType

Is the identifier of the Bill-Of-Material.

EffectivePeriod TimePeriod

Identifies the time period in which the BOM is effective.

Item reference

Identifies the Items that the Bill-Of-Material creates. There may be other items created as a by-product of this same process. The first occurance is the primary Item of this BOM.

Name Name

Is the Name of the Bill-Of-Material

Note Note

Free-form notes about the BOM.

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.

Site reference
Status reference
TrackingInd Indicator

Indicates that this BOM will be tracked through its life cycle.

Indicates if the semantic name is needed or not.

Usage Usage

Describes the use of The Bill of Material being defined. Examples are Production, Rework, Engineering, Construction, and Sales

UserArea reference

Option
Structure:
Elements:
Name Type Description
DefaultInd Indicator

Identifies a default option on a Bill-Of-Material.

Indicates if the semantic name is needed or not.

Description Description

Free-form description of the option.

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..

ExclusiveInd Indicator

Identifies within a Bill of Material structure if an OptionClass or Option conflicts with another part of the Bill of Material structure and therefore if chosen, must not be combined with any other OptionClass or Option within that branch of the Bill of Material. In other words if a given Option is choosen another Option out of the same OptionClass can not be selected.

Indicates if the semantic name is needed or not.

Id Id

Is the Option identifier.

Generic identifier type with open qualifyingAgency.

ItemData reference
Name Name

Is the name of the option.

Note Note

Free-form notes about the Option.

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.

UserArea reference

OptionClass
Structure:
Elements:
Name Type Description
Description Description

Free-form description of the OptionClass.

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..

ExclusiveInd Indicator

Identifies within a Bill of Material structure if an OptionClass or Option conflicts with another part of the Bill of Material structure and therefore if chosen, must not be combined with any other OptionClass or Option within that branch of the Bill of Material. In other words if a given Option is choosen another Option out of the same OptionClass can not be selected.

Indicates if the semantic name is needed or not.

Id Id

Is the identifier of the OptionClass.

Generic identifier type with open qualifyingAgency.

MandatoryIndicator Indicator

Indicates if the semantic name is needed or not.

Name Name

Is the name of the OptionClass.

Note Note

Free-Form note about the OptionClass.

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.

Option reference
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