ListBillOfMaterial schema, example, validation rules, validation stylesheet

ListBillOfMaterial type: ListBillOfMaterial

The purpose of the ListBillOfMaterial is to communicate one or more summary listings of BOM information to another business application component. This may be the result of a GetList request or it may be initiated by some other business event.

ListBillOfMaterial extends: BusinessObjectDocument
Structure:
Elements:
Name Type Description
DataArea ListBillOfMaterialDataArea

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

ListBillOfMaterialDataArea extends: DataArea
Structure:
Elements:
Name Type Description
BillOfMaterial reference
List reference

ListBillOfMaterial Scenario Diagram

List schema

List type: List

The purpose of the LIST verb is to enable a business software component to respond to a GETLIST request or to proactively send a listing of summary information containing many instances of occurrences of data for a noun to one or more other business software components.The results of a LIST may then be used as is, or they may be used to select a specific instance of a document or entity in order to issue a detail GET request.Although BODs based on this verb do not commonly cause updates to occur, there may be times when the component receiving the LIST decides to use the information it receives to update. This is entirely the decision of the receiving software component and is not forbidden.The behavior of the LIST verb is quite straight forward with a few exceptions. The LIST response to any GETLIST request needs to read the request carefully to ensure the response is returning the requested Data Types. The LIST needs to ensure the response to the GETLIST does not exceed the maxItems value.The LIST needs to find the specific Field Identifiers that are used for the Field-Based Selection or Range-Based Selection and process them accordingly. The attributes associated with the LIST BODs are as follows: o rsstart attribute is a number that idicates the starting record for the section of the resulting set returned in the list message. This value should always match the rsstart value in the originating GetList BOD. o rscount attribute is a number that indicates the number of records returned in the message. The subsequent request for additional records should have a rsstart value of rscount + 1. o rstotal attribute is a number that indicates the total number of records in the result set. o rscomplete attribute is a Boolean that indicates that the list provided exhaust the possible values. o rsref attribute is a string that represents the implementation-specific result set identifier for subsequent requests.

List extends: ConfirmableVerb
Structure:
Attributes:
Name Type Usage Description
rsComplete xs:boolean optional
rsCount xs:positiveInteger optional
rsRef xs:string optional
rsStart xs:positiveInteger optional
rsTotal 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