GetBillOfMaterial schema, example, validation rules, validation stylesheet

GetBillOfMaterial type: GetBillOfMaterial

The purpose of the GetBillOfMaterial is to enable an application to request specific Item Bill of Material information from another business application module. The response to the GetBillOfMaterial is the ShowBillOfMaterial. 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.

GetBillOfMaterial extends: BusinessObjectDocument
Structure:
Elements:
Name Type Description
DataArea GetBillOfMaterialDataArea

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

GetBillOfMaterialDataArea extends: DataArea
Structure:
Elements:
Name Type Description
BillOfMaterial reference
Get reference

GetBillOfMaterial 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

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