RosettaNet XML Message Guideline
2C8_MG_R01_00_00_BillOfMaterialNotification.htm (20-Dec-2001 18:05)

This document has been prepared by RosettaNet (http://www.rosettanet.org) from requirements
gathered during the cluster/segment workshops and in conformance with the RosettaNet methodology.

 

1

1

BillOfMaterial

2

0..n

       |-- Attachment

3

0..1

       |    |-- description.FreeFormText

4

0..1

       |    |-- GlobalAttachmentDescriptionCode

5

1

       |    |-- GlobalMimeTypeQualifierCode

6

1

       |    |-- UniversalResourceIdentifier

7

1..n

       |-- BillOfMaterialItem

8

0..n

       |    |-- AlternateItem

9

1

       |    |    |-- GlobalPreferredStatusCode

10

1

       |    |    |-- ProductIdentification

11

0..1

       |    |    |    |-- GlobalProductIdentifier

12

0..n

       |    |    |    |-- PartnerProductIdentification

13

1

       |    |    |    |    |-- GlobalPartnerClassificationCode

14

1

       |    |    |    |    |-- ProprietaryProductIdentifier

15

0..1

       |    |    |    |    |-- revisionIdentifier.FreeFormText

16

0..1

       |    |-- description.FreeFormText

17

1

       |    |-- effectiveDatePeriod.DatePeriod

18

1

       |    |    |-- beginDate.DateStamp

19

0..1

       |    |    |-- endDate.DateStamp

20

0..1

       |    |-- GlobalBillOfMaterialTypeCode

21

0..1

       |    |-- GlobalProductQuantityTypeCode

22

1

       |    |-- ProductIdentification

23

0..1

       |    |    |-- GlobalProductIdentifier

24

0..n

       |    |    |-- PartnerProductIdentification

25

1

       |    |    |    |-- GlobalPartnerClassificationCode

26

1

       |    |    |    |-- ProprietaryProductIdentifier

27

0..1

       |    |    |    |-- revisionIdentifier.FreeFormText

28

0..1

       |    |-- ProductQuantity

29

0..1

       |    |-- ProprietarySequenceIdentifier

30

0..n

       |    |-- referenceDesignatorName.FreeFormText

31

1

       |    |-- SerialSpecification

32

1

       |    |    |-- isSerializationRequired.AffirmationIndicator

33

0..n

       |    |    |-- SerialNumberIdentification

34

1

       |    |    |    |-- ProprietarySerialIdentifier

35

1

       |    |    |    |-- SequenceNumber

36

0..n

       |    |    |-- SerialNumberRange

37

1

       |    |    |    |-- firstSerialNumber.ProprietarySerialIdentifier

38

1

       |    |    |    |-- Increment

39

1

       |    |    |    |-- lastSerialNumber.ProprietarySerialIdentifier

40

1

       |    |    |    |-- SequenceNumber

41

0..n

       |    |-- SubComponent

42

1

       |    |    |-- (BillOfMaterialItem)

43

1

       |-- effectiveDatePeriod.DatePeriod

44

1

       |    |-- beginDate.DateStamp

45

0..1

       |    |-- endDate.DateStamp

46

0..1

       |-- previousNotification.ProprietaryDocumentIdentifier

47

1

       |-- ProductIdentification

48

0..1

       |    |-- GlobalProductIdentifier

49

0..n

       |    |-- PartnerProductIdentification

50

1

       |    |    |-- GlobalPartnerClassificationCode

51

1

       |    |    |-- ProprietaryProductIdentifier

52

0..1

       |    |    |-- revisionIdentifier.FreeFormText

53

1

fromRole.PartnerRoleDescription

54

1

       |-- ContactInformation

55

1

       |    |-- contactName.FreeFormText

56

1

       |    |-- EmailAddress

57

0..1

       |    |-- facsimileNumber.CommunicationsNumber

58

1

       |    |-- telephoneNumber.CommunicationsNumber

59

1

       |-- GlobalPartnerRoleClassificationCode

60

1

       |-- PartnerDescription

61

1

       |    |-- BusinessDescription

62

1

       |    |    |-- GlobalBusinessIdentifier

63

1

       |    |    |-- GlobalSupplyChainCode

64

1

       |    |-- GlobalPartnerClassificationCode

65

1

GlobalDocumentFunctionCode

66

1

thisDocumentGenerationDateTime.DateTimeStamp

67

1

thisDocumentIdentifier.ProprietaryDocumentIdentifier

68

1

toRole.PartnerRoleDescription

69

0..1

       |-- ContactInformation

70

1

       |    |-- contactName.FreeFormText

71

1

       |    |-- EmailAddress

72

0..1

       |    |-- facsimileNumber.CommunicationsNumber

73

1

       |    |-- telephoneNumber.CommunicationsNumber

74

1

       |-- GlobalPartnerRoleClassificationCode

75

1

       |-- PartnerDescription

76

1

       |    |-- BusinessDescription

77

1

       |    |    |-- GlobalBusinessIdentifier

78

1

       |    |    |-- GlobalSupplyChainCode

79

1

       |    |-- GlobalPartnerClassificationCode

 

Guideline Information

3: description

User Notes: This field may be used to supply the file name of the attachment.

 

4: GlobalAttachmentDescriptionCode

Entity Instances
Assembly drawings
Block diagrams
BOM: Bill of Material
CAD information: Computer Aided Design Information
Schematics
Test instructions
Assembly/fabrication instructions
Quality data: Yield data
Sample plan: Quantity of samples in a sample plan
Logistics: For example: packaging, carrier requirements, etc.
Blueprints

 

5: GlobalMimeTypeQualifierCode

Entity Instances
MIME Media Types as published by IANA (http://www.iana.org/).

 

6: UniversalResourceIdentifier

Constraint: This value MUST follow the Content-ID reference syntax per RFC 2111 and MUST refer to the MIME Content-ID of the attachment.

User Notes: Reference to the content ID of the attached document.

 

9: GlobalPreferredStatusCode

Entity Instances
Primary: Primary or preferred approved manufacturer or supplier.
Alternate: Alternate approved manufacturer or supplier.
Disqualified: This particular manufacturer or supplier has been disqualified from supplying this part at the approved revision level.
Split: A particular part that is provided by different suppliers to reduce risk or get a price discount, etc.
End of Life: A particular part that is going to be used in production only until current inventories are exhausted.
Pilot Approved: New Product Introduction (NPI) approved. This is used in a pilot or development of a product or product line and is not meant to be production approved.
Under Qualification: A particular part that is undergoing qualification testing for use in production.
Not Available: This part is not available to the trading partners.
Other: Need agreement before the transaction may continue.

 

10, 22, 47: ProductIdentification

Constraint: At least one business identifier must be provided: GlobalProductIdentifier or at least one entry in PartnerProductIdentification.

 

13, 25, 50, 64, 79: GlobalPartnerClassificationCode

Entity Instances
Carrier: Product carrier for transporting goods in supply chain.
Distributor: Product distributor in supply chain.
End User: Product end user in supply chain.
End User Government: End user government.
Financier: Financial service provider in supply chain
Manufacturer: Product manufacturer in supply chain.
Retailer: Product retailer in supply chain.
Shopper: Product shopper in supply chain.
Freight Forwarder: Product freight forwarder for transporting goods in supply chain.
Broker: Representative of a third party.
Customs Broker: Product customs broker in supply chain.
Warehouser: Product warehouser in supply chain.
Distribution Center: Product distributor in supply chain.
Contract Manufacturer: The party responsible for the services rendered.
Reseller: A party buys goods from a manufacturer and resells them to customers unchanged.
Original Equipment Manufacturer: Product manufacturer of original equipment in the supply chain.

 

20: GlobalBillOfMaterialTypeCode

Entity Instances
Direct material: A part or component that is a part of the final assembly.
Indirect material: Items which are not in the final assembly. An example would be material used for packaging such as a pallet or packing tape that is used to seal the carton.
Sub-assembly: A sub-assembly that is purchased or made that is part of the final assembly of the item.
Phantom sub-assembly: Phantom sub-assembly is used to group optional components on an assembly but is not a physical sub-assembly. A phantom sub-assembly can never be an orderable item. It is used mostly internally to a company but the information concerning the internal workings of the BOM may make this sharable between trading partners.
End product: Top level Bill Of Material from the suppliers point of view. If the final product is a single discrete part and not an assembly the “direct material” should be used.
Kit: Shippable replacement part which may be a sub-assembly of the “end product” or an accessory.
Setup: Material used in the setup of a manufacturing line.
As needed: Items which are only used on an as needed basis and may not always be part of “end product”.
Reference: A document for the item, like engineering note or URI to the item.
Non-tangible: Items such as a software load option in the case of a PC build or a ROM software load. The item does not physically exist as a touchable item. Royalties may be payable but there is no requirement to order the product.
Other: Need agreement before the transaction may continue.

 

21: GlobalProductQuantityTypeCode

Entity Instances
Use per a set quantity of assemblies: Quantity is required to assemble a specific part that consists of several items and that uses several smaller identical assemblies. This is also used to indirect materials spread over on pallet or packed in box.
Shrinkage: Quantity is required to correct production quantities being ordered.
Per assembly: Quantity is required for an each occurrence, which is usually the case for most components such as resistors, SOC, VLSI, capacitors, etc.
As needed: Quantity is required when specifying bulk items such as adhesive or heat sink paste.
Per setup: Quantity is required for such as a setup quantity of indirect materials used in a production run and cannot be known with certainty over how many assemblies this applies since it depends upon the quantity of the production run.

 

29: ProprietarySequenceIdentifier

User Notes: This is the "line number" or "find number" used to identify the part within the Bill Of Material.

 

31: SerialSpecification

Constraint: If isSerializationRequired.AffirmationIndicator = 'Yes' then at least one occurrence of SerialNumberidentification or SerialNumberRange is required.

 

42: BillOfMaterialItem

User Notes: This property infers a reference back to the BillOfMaterialItem level (by being in parentheses), that is, allows looping to occur. Subsequently the use of all the elements contained in BillOfMaterialItem are available for use in describing SubComponent.

 

59: GlobalPartnerRoleClassificationCode

Entity Instances
Design Owner

 

63, 78: GlobalSupplyChainCode

Entity Instances
Information Technology: The information technology supply chain.
Electronic Components: The electronic components supply chain.

Semiconductor Manufacturing: The semiconductor manufacturing supply chain.

 

65: GlobalDocumentFunctionCode

Entity Instances
Request: The business document is a request for a business action to be performed by a partner

 

74: GlobalPartnerRoleClassificationCode

Entity Instances
Integrator

 

Business Properties

Name

Definition

description

A description of a process, thing, action, etc.

revisionIdentifier

Free form text that identifies a revision to a proprietary serial number.

effectiveDatePeriod

The date range indicating when information or an activity is valid.

beginDate

The start date of a date period.

endDate

The end date of a date period.

referenceDesignatorName

Identifies a single instance of a component. Normally referenceDesignator is alphabetic, graphically on the schematic and is used in the electrical interconnect description.

isSerializationRequired

Indicates whether serial numbers must be enumerated.

firstSerialNumber

The first or beginning serial number in a range of serial numbers.

lastSerialNumber

The last or ending serial number in a range of serial numbers.

previousNotification

Identifies the previous notification message if this is an update to it.

fromRole

The role initiating a business document exchange.

contactName

Name of the contact person(s) within the organization.

facsimileNumber

The numerical schema designed to achieve contact via facsimile.

telephoneNumber

The numerical schema designed to achieve contact via telephone.

thisDocumentGenerationDateTime

The date-time stamp indicating when this document was generated.

thisDocumentIdentifier

The information that identifies the business document being sent. This identifier is used to represent the specific business document associated with the defined business process.

toRole

The role receiving the document in a business document exchange.

 

Business Data Entities

Name

Definition

BillOfMaterial

The collection of business properties that describes a bill of material for a product.

Attachment

A business property that describes additional information regarding a product or process.

BillOfMaterialItem

The collection of business properties that describe an assembly, kit or single item. It may also be used to describe "phantom" parts.

AlternateItem

The collection of business properties that describe a functionally identical or comparable part that may be used in place of a primary or main part.

ProductIdentification

The collection of business properties that describe proprietary and global identifier information regarding a product.

PartnerProductIdentification

The collection of business properties that describe proprietary part information.

DatePeriod

The collection of business properties that specify the number of days by a start and end date stamp.

SerialSpecification

The collection of business properties that describe serial number data used to uniquely identify a finished product.

SerialNumberIdentification

The collection of business properties that describe a collection of non-sequential serial numbers.

SerialNumberRange

The collection of business properties that describe a collection of sequential serial numbers.

SubComponent

The collection of business properties that describe the bill of material for a subcomponent of the product.

PartnerRoleDescription

The collection of business properties that describes a business partner's role in a partner interface process.

ContactInformation

The collection of business properties that provides communication and address information for contacting a person, organization or business.

PartnerDescription

The collection of business properties that describes a business partner's identity and their function in a supply chain.

BusinessDescription

The collection of business properties that describes a business identity and location.

 

Fundamental Business Data Entities

Name

Definition

Data Type

Min

Max

Representation

FreeFormText

Unformatted text.

String

1

 

 

GlobalAttachmentDescriptionCode

Code identifying the type of product attachment, e.g. assembly instructions, block diagrams, test requirements, etc.

String

1

 

 

GlobalMimeTypeQualifierCode

The MIME type. Refer to http://www.iana.org for a list of types.

String

1

 

 

UniversalResourceIdentifier

A network-centric identifier that provides the identity of a resource.

String

1

 

 

GlobalPreferredStatusCode

Code identifying the status of an approved product.

String

1

 

 

GlobalProductIdentifier

Global unique product identifier. RosettaNet has adopted the Global Trade Identification Number (GTIN).

String

14

14

9(14)

GlobalPartnerClassificationCode

Code identifying a partner's function in the supply chain.

String

1

 

 

ProprietaryProductIdentifier

An internal identifier used to identify a product.

String

1

 

 

DateStamp

Specifies a specific date. Date stamp based on the ISO 8601 specification. The "Z" following the day identifier (DD) is used to indicate Coordinated Universal Time. Informal format: CCYYMMDDZ

Date

9

9

9(8)X

GlobalBillOfMaterialTypeCode

Code identifying the type of product or item on the Bill Of Material.

String

1

 

 

GlobalProductQuantityTypeCode

Code identifying the type of the quantity needed for assemblies or setting up.

String

1

 

 

ProductQuantity

A quantity specifying the number of product units.

Real

1

 

 

ProprietarySequenceIdentifier

A proprietary identifier which identifies the order of a designated element within a specified set.

String

1

 

 

AffirmationIndicator

Used to indicate "yes", "no" statements.

String

2

3

 

ProprietarySerialIdentifier

Unique serial identifier assigned to the product.

String

1

 

 

SequenceNumber

A positive integer which identifies the order of a designated element within a specified set.

String

1

 

 

Increment

A factor which when applied to a serial number in a given range will yield the next serial number in that range.

String

1

 

 

ProprietaryDocumentIdentifier

Unique identifier, i.e. a numeric value or alphanumeric value, for a business document.

String

1

 

 

EmailAddress

Electronic mail address.

String

1

 

 

CommunicationsNumber

The electro-technical communication number, e.g., telephone number, facsimile number, pager number.

String

1

30

X(30)

GlobalPartnerRoleClassificationCode

Identifying a partner role within a Supply Chain.  Could be additional value to an existing code table.

String

1

 

 

GlobalBusinessIdentifier

A unique business identifier. The DUNS number is specified by RosettaNet.

Integer

9

9

9(9)

GlobalSupplyChainCode

Code identifying the supply chain for the partner's function.

String

1

 

 

GlobalDocumentFunctionCode

Code identifying the function of a document as either a request or a response.

String

1

 

 

DateTimeStamp

Specifies an instance in time. Based on the ISO 8601 specification where "CC" represents the century, "YY" the year, "MM" the month and "DD" the day. The letter "T" is the date/time separator and "hh", "mm", "ss.sss" represent hour, minute and second respectively. This representation is immediately followed by a "Z" to indicate Coordinated Universal Time. Informal format: CCYYMMDDThhmmss.sssZ

DateTime

13

20

9(8)X9(6)V9(3)X