BOMHeader
Information that generally describes the Bill of Material Structure and its contents.
Element information
Namespace: http://www.openapplications.org/oagis/10
Schema document: Common.xsd
Type: BOMHeaderType
Properties: Global, Qualified, ID: oagis-id-b21b8e3b061845ad8cb2509c69b29986
Content
- Sequence [1..1]
- ID [0..1] Is the Identifiers of the given instance of an entity within the scope of the integration. The schemeAgencyID attribute identifies the party that provided or knows this party by the given identifier.
- RevisionID [0..1] Is the revision of the semantically named document. The combination of the ID and its revision uniquely identifies the associated entity.
- VariationID [0..1]
- DocumentIDSet [0..*]
- LastModificationDateTime [0..1] The datetime on which the object was last modified
- DocumentDateTime [0..1] The date that document was created within the system of record.
- Description [0..*]
- Note [0..*]
- DocumentReference [0..*]
- Attachment [0..*] The Attachment represents binary data files that may be included within a BOD. These files replace the paper specifications and drawings attached to a BOD definition to clearly communicate design requirements. This Data Type is optional. Attachment usage is further defined by its position.
- Status [0..*] Indicates the status of the associated object by providing the Status Code along with a description and when the status is effective.
- AlternateBOMReference [0..*] Identifies an alternate BOM that maybe used in place of the one being referenced in this particular instance.
- ParentBOMReference [0..1] Reference to the parent BOM of the current BOM.
- ChildBOMReference [0..*] Reference to a child BOM of the current BOM.
- RouteReference [0..*] Reference to a Routing.
- Name [0..*] Identifies the Name of the object in which associated.
- UsageDescription [0..1] Describes how an ITEM or product is consumed during the manufacturing process.
- Effectivity [0..*] Specifies effectivity of an associated object. Effectivity is expressed may be expressed as: multiple ranges, values, time period or as associated to a specific Item.
- EffectiveTimePeriod [0..1] A time period in which an associated object is effective.
- Location [0..*] The location of a thing, as captured by an address (or addresses), GPS Coordinates, and/or in relation to other locations.
- TrackingIndicator [0..1] Indicates whether the related object is to be tracked
- BatchSizeQuantity [0..1] This is the quantity of a product or item made during a batch production run or the amount of material produced by the Operation being defined. An example would be how many cookies produced by a particular Operation..
- Extension [0..1] Allows the user of OAGIS to extend the specification in order to provide additional information that is not captured in OAGIS.This is done by defining the additional information in XML Schema and referencing the new schema in the xml instance document through the use of namespaces. Once this is done the additional information defined there can be carried in the BOD XML instance document.The Open Applications Group will make best efforts to quickly consider all proposed submissions.The Extension is always the last element in all components, except where the component has been extended inline.
from type DocumentIdentificationBaseTypefrom type HeaderBaseTypefrom group FreeFormTextGroupfrom group ReferencesGroupfrom type StatusHeaderBaseTypefrom type BOMHeaderBaseType
Attributes
None
Used in
Sample instance
<BOMHeader> <ID/> <RevisionID>normalizedString</RevisionID> <VariationID>normalizedString</VariationID> <DocumentIDSet> <ID/> </DocumentIDSet> <LastModificationDateTime></LastModificationDateTime> <DocumentDateTime></DocumentDateTime> <Description/> <Note/> <DocumentReference> <ID/> <RevisionID>normalizedString</RevisionID> <VariationID>normalizedString</VariationID> <DocumentIDSet> <ID/> </DocumentIDSet> <DocumentDateTime></DocumentDateTime> <Description/> <Note/> <Status> <ID/> <IDSet>... </IDSet> <Code/> <Description/> <ReasonCode>normalizedString</ReasonCode> <Reason/> <EffectiveTimePeriod>.................. </EffectiveTimePeriod> <Extension>....................................... </Extension> </Status> <LineNumberID/> <LineIDSet> <ID/> </LineIDSet> <Extension> <AnyExtension> <!--any element--> </AnyExtension> <Amount/> <Code/> <DateTime></DateTime> <ID/> <Indicator>true</Indicator> <Measure/> <Name/> <Number>1.0</Number> <Quantity/> <Text/> <Time></Time> <ValueText>string</ValueText> </Extension> </DocumentReference> <Attachment> <ID/> <IDSet> <ID/> </IDSet> <EmbeddedDataBinaryObject/> <URI>normalizedString</URI> <ISBN>normalizedString</ISBN> <FileName/> <DocumentDateTime></DocumentDateTime> <Description/> <Note/> <FileTypeCode>normalizedString</FileTypeCode> <FileSizeQuantity>1.0</FileSizeQuantity> <Title/> <Extension> <AnyExtension> <!--any element--> </AnyExtension> <Amount/> <Code/> <DateTime></DateTime> <ID/> <Indicator>true</Indicator> <Measure/> <Name/> <Number>1.0</Number> <Quantity/> <Text/> <Time></Time> <ValueText>string</ValueText> </Extension> </Attachment> <Status> <ID/> <IDSet> <ID/> </IDSet> <Code/> <Description/> <ReasonCode>normalizedString</ReasonCode> <Reason/> <EffectiveTimePeriod> <InclusiveIndicator>true</InclusiveIndicator> <StartDateTime></StartDateTime> <StartTime>token</StartTime> <Duration>P1Y2M3DT10H</Duration> <EndDateTime></EndDateTime> <EndTime>token</EndTime> </EffectiveTimePeriod> <Extension> <AnyExtension> <!--any element--> </AnyExtension> <Amount/> <Code/> <DateTime></DateTime> <ID/> <Indicator>true</Indicator> <Measure/> <Name/> <Number>1.0</Number> <Quantity/> <Text/> <Time></Time> <ValueText>string</ValueText> </Extension> </Status> <AlternateBOMReference> <ID/> <RevisionID>normalizedString</RevisionID> <VariationID>normalizedString</VariationID> <DocumentIDSet> <ID/> </DocumentIDSet> <DocumentDateTime></DocumentDateTime> <Description/> <Note/> <Status> <ID/> <IDSet>... </IDSet> <Code/> <Description/> <ReasonCode>normalizedString</ReasonCode> <Reason/> <EffectiveTimePeriod>.................. </EffectiveTimePeriod> <Extension>....................................... </Extension> </Status> <LineNumberID/> <LineIDSet> <ID/> </LineIDSet> <Effectivity> <ID/> <IDSet>... </IDSet> <Name/> <Preference>... </Preference> <EffectiveValueList>... </EffectiveValueList> <EffectiveRange>... </EffectiveRange> <EffectiveTimePeriod>.................. </EffectiveTimePeriod> <Extension>....................................... </Extension> </Effectivity> <Item> <ID/> <RevisionID>normalizedString</RevisionID> <VariationID>normalizedString</VariationID> <ItemIDSet>... </ItemIDSet> <CustomerItemIdentification>... </CustomerItemIdentification> <ManufacturerItemIdentification>... </ManufacturerItemIdentification> <SupplierItemIdentification>... </SupplierItemIdentification> <UPCID>normalizedString</UPCID> <EPCID>normalizedString</EPCID> <GTINID>normalizedString</GTINID> <Description/> <Note/> <Classification>... </Classification> <Specification>... </Specification> <HazardousMaterial>... </HazardousMaterial> <Packaging>... </Packaging> <Dimensions>... </Dimensions> <ExportControl>... </ExportControl> <HarmonizedTariff>... </HarmonizedTariff> <Trademark>... </Trademark> <DocumentReference>... </DocumentReference> <Attachment>... </Attachment> <CountryOfOriginCode>token</CountryOfOriginCode> <RFID>normalizedString</RFID> <SerialNumberID>normalizedString</SerialNumberID> <Lot>... </Lot> <Extension>....................................... </Extension> </Item> <Extension> <AnyExtension> <!--any element--> </AnyExtension> <Amount/> <Code/> <DateTime></DateTime> <ID/> <Indicator>true</Indicator> <Measure/> <Name/> <Number>1.0</Number> <Quantity/> <Text/> <Time></Time> <ValueText>string</ValueText> </Extension> </AlternateBOMReference> <ParentBOMReference> <ID/> <RevisionID>normalizedString</RevisionID> <VariationID>normalizedString</VariationID> <DocumentIDSet> <ID/> </DocumentIDSet> <DocumentDateTime></DocumentDateTime> <Description/> <Note/> <Status> <ID/> <IDSet>... </IDSet> <Code/> <Description/> <ReasonCode>normalizedString</ReasonCode> <Reason/> <EffectiveTimePeriod>.................. </EffectiveTimePeriod> <Extension>....................................... </Extension> </Status> <LineNumberID/> <LineIDSet> <ID/> </LineIDSet> <Effectivity> <ID/> <IDSet>... </IDSet> <Name/> <Preference>... </Preference> <EffectiveValueList>... </EffectiveValueList> <EffectiveRange>... </EffectiveRange> <EffectiveTimePeriod>.................. </EffectiveTimePeriod> <Extension>....................................... </Extension> </Effectivity> <Item> <ID/> <RevisionID>normalizedString</RevisionID> <VariationID>normalizedString</VariationID> <ItemIDSet>... </ItemIDSet> <CustomerItemIdentification>... </CustomerItemIdentification> <ManufacturerItemIdentification>... </ManufacturerItemIdentification> <SupplierItemIdentification>... </SupplierItemIdentification> <UPCID>normalizedString</UPCID> <EPCID>normalizedString</EPCID> <GTINID>normalizedString</GTINID> <Description/> <Note/> <Classification>... </Classification> <Specification>... </Specification> <HazardousMaterial>... </HazardousMaterial> <Packaging>... </Packaging> <Dimensions>... </Dimensions> <ExportControl>... </ExportControl> <HarmonizedTariff>... </HarmonizedTariff> <Trademark>... </Trademark> <DocumentReference>... </DocumentReference> <Attachment>... </Attachment> <CountryOfOriginCode>token</CountryOfOriginCode> <RFID>normalizedString</RFID> <SerialNumberID>normalizedString</SerialNumberID> <Lot>... </Lot> <Extension>....................................... </Extension> </Item> <Extension> <AnyExtension> <!--any element--> </AnyExtension> <Amount/> <Code/> <DateTime></DateTime> <ID/> <Indicator>true</Indicator> <Measure/> <Name/> <Number>1.0</Number> <Quantity/> <Text/> <Time></Time> <ValueText>string</ValueText> </Extension> </ParentBOMReference> <ChildBOMReference> <ID/> <RevisionID>normalizedString</RevisionID> <VariationID>normalizedString</VariationID> <DocumentIDSet> <ID/> </DocumentIDSet> <DocumentDateTime></DocumentDateTime> <Description/> <Note/> <Status> <ID/> <IDSet>... </IDSet> <Code/> <Description/> <ReasonCode>normalizedString</ReasonCode> <Reason/> <EffectiveTimePeriod>.................. </EffectiveTimePeriod> <Extension>....................................... </Extension> </Status> <LineNumberID/> <LineIDSet> <ID/> </LineIDSet> <Effectivity> <ID/> <IDSet>... </IDSet> <Name/> <Preference>... </Preference> <EffectiveValueList>... </EffectiveValueList> <EffectiveRange>... </EffectiveRange> <EffectiveTimePeriod>.................. </EffectiveTimePeriod> <Extension>....................................... </Extension> </Effectivity> <Item> <ID/> <RevisionID>normalizedString</RevisionID> <VariationID>normalizedString</VariationID> <ItemIDSet>... </ItemIDSet> <CustomerItemIdentification>... </CustomerItemIdentification> <ManufacturerItemIdentification>... </ManufacturerItemIdentification> <SupplierItemIdentification>... </SupplierItemIdentification> <UPCID>normalizedString</UPCID> <EPCID>normalizedString</EPCID> <GTINID>normalizedString</GTINID> <Description/> <Note/> <Classification>... </Classification> <Specification>... </Specification> <HazardousMaterial>... </HazardousMaterial> <Packaging>... </Packaging> <Dimensions>... </Dimensions> <ExportControl>... </ExportControl> <HarmonizedTariff>... </HarmonizedTariff> <Trademark>... </Trademark> <DocumentReference>... </DocumentReference> <Attachment>... </Attachment> <CountryOfOriginCode>token</CountryOfOriginCode> <RFID>normalizedString</RFID> <SerialNumberID>normalizedString</SerialNumberID> <Lot>... </Lot> <Extension>....................................... </Extension> </Item> </ChildBOMReference> <RouteReference> <ID/> <RevisionID>normalizedString</RevisionID> <VariationID>normalizedString</VariationID> <DocumentIDSet> <ID/> </DocumentIDSet> <DocumentDateTime></DocumentDateTime> <Description/> <Note/> <Status> <ID/> <IDSet>... </IDSet> <Code/> <Description/> <ReasonCode>normalizedString</ReasonCode> <Reason/> <EffectiveTimePeriod>.................. </EffectiveTimePeriod> <Extension>....................................... </Extension> </Status> <LineNumberID/> <LineIDSet> <ID/> </LineIDSet> <ProductionOrderReference> <ID/> <RevisionID>normalizedString</RevisionID> <VariationID>normalizedString</VariationID> <DocumentIDSet>... </DocumentIDSet> <DocumentDateTime></DocumentDateTime> <Description/> <Note/> <Status>... </Status> <LineNumberID/> <LineIDSet>... </LineIDSet> <ItemIdentification>... </ItemIdentification> <Facility>... </Facility> <SerialLot>... </SerialLot> <Extension>....................................... </Extension> </ProductionOrderReference> <OperationReference> <ID/> <RevisionID>normalizedString</RevisionID> <VariationID>normalizedString</VariationID> <DocumentIDSet>... </DocumentIDSet> <DocumentDateTime></DocumentDateTime> <Description/> <Note/> <Status>... </Status> <LineNumberID/> <LineIDSet>... </LineIDSet> <GroupName/> <SequenceCode>normalizedString</SequenceCode> <StepID>normalizedString</StepID> <StepTypeCode>normalizedString</StepTypeCode> <Extension>....................................... </Extension> </OperationReference> <Extension> <AnyExtension> <!--any element--> </AnyExtension> <Amount/> <Code/> <DateTime></DateTime> <ID/> <Indicator>true</Indicator> <Measure/> <Name/> <Number>1.0</Number> <Quantity/> <Text/> <Time></Time> <ValueText>string</ValueText> </Extension> </RouteReference> <Name/> <UsageDescription/> <Effectivity> <ID/> <IDSet> <ID/> </IDSet> <Name/> <Preference> <ID/> <IDSet>... </IDSet> <PrioritySequenceValue>1</PrioritySequenceValue> <EffectiveTimePeriod>.................. </EffectiveTimePeriod> <AvailableTimePeriod>.................. </AvailableTimePeriod> <UnavailableTimePeriod>.................. </UnavailableTimePeriod> <Description/> <Note/> <Extension>....................................... </Extension> </Preference> <EffectiveValueList> <ID/> <IDSet>... </IDSet> <InclusiveIndicator>true</InclusiveIndicator> <Extension>....................................... </Extension> </EffectiveValueList> <EffectiveRange> <ID/> <IDSet>... </IDSet> <InclusiveIndicator>true</InclusiveIndicator> <StartID>normalizedString</StartID> <RangeCountNumber>1</RangeCountNumber> <EndID>normalizedString</EndID> <Extension>....................................... </Extension> </EffectiveRange> <EffectiveTimePeriod> <InclusiveIndicator>true</InclusiveIndicator> <StartDateTime></StartDateTime> <StartTime>token</StartTime> <Duration>P1Y2M3DT10H</Duration> <EndDateTime></EndDateTime> <EndTime>token</EndTime> </EffectiveTimePeriod> <Extension> <AnyExtension> <!--any element--> </AnyExtension> <Amount/> <Code/> <DateTime></DateTime> <ID/> <Indicator>true</Indicator> <Measure/> <Name/> <Number>1.0</Number> <Quantity/> <Text/> <Time></Time> <ValueText>string</ValueText> </Extension> </Effectivity> <EffectiveTimePeriod> <InclusiveIndicator>true</InclusiveIndicator> <StartDateTime></StartDateTime> <StartTime>token</StartTime> <Duration>P1Y2M3DT10H</Duration> <EndDateTime></EndDateTime> <EndTime>token</EndTime> </EffectiveTimePeriod> <Location> <ID/> <IDSet> <ID/> </IDSet> <Name/> <Directions/> <Coordinate> <ID/> <IDSet>... </IDSet> <Description/> <ReferenceSystemID/> <VerticalReferenceSystemID/> <VerticalMeasure>1.0</VerticalMeasure> <LatitudeMeasure>1.0</LatitudeMeasure> <LongitudeMeasure>1.0</LongitudeMeasure> <VerticalAccuracyMeasure>1.0</VerticalAccuracyMeasure> <HorizontalAccuracyMeasure>1.0</HorizontalAccuracyMeasure> <Extension>....................................... </Extension> </Coordinate> <Address> <ID/> <IDSet>... </IDSet> <Name/> <AttentionOfName/> <CareOfName/> <BuildingNumber/> <BuildingName/> <BlockName/> <StreetName/> <StreetTypeCode>normalizedString</StreetTypeCode> <Floor/> <Unit/> <StairCase/> <Door/> <PostOfficeBox/> <DeliveryPointID>normalizedString</DeliveryPointID> <PlotID>normalizedString</PlotID> <CityName/> <CitySubDivisionName/> <CountrySubDivisionCode>token</CountrySubDivisionCode> <CountryCode>token</CountryCode> <PostalCode>normalizedString</PostalCode> <Status>... </Status> <Preference>... </Preference> <GeographicalCoordinate>... </GeographicalCoordinate> <Usage>... </Usage> <Extension>....................................... </Extension> </Address> <Contact> <ID/> <IDSet>... </IDSet> <PersonName>... </PersonName> <RoleCode>normalizedString</RoleCode> <JobTitle/> <Responsibility/> <OrganizationUnitID>normalizedString</OrganizationUnitID> <Communication>... </Communication> <TelephoneCommunication>... </TelephoneCommunication> <EMailAddressCommunication>... </EMailAddressCommunication> <InternetAddressCommunication>... </InternetAddressCommunication> <Preference>... </Preference> <EffectiveTimePeriod>.................. </EffectiveTimePeriod> <Extension>....................................... </Extension> </Contact> <Communication> <ID/> <IDSet>... </IDSet> <Name/> <ChannelCode>normalizedString</ChannelCode> <UseCode>normalizedString</UseCode> <CountryDialingCode>normalizedString</CountryDialingCode> <AreaDialingCode>normalizedString</AreaDialingCode> <DialNumber/> <PhoneExtension/> <Access/> <Address>... </Address> <URI>normalizedString</URI> <HTMLPreferredIndicator>true</HTMLPreferredIndicator> <Text/> <EffectiveTimePeriod>.................. </EffectiveTimePeriod> <Preference>... </Preference> <Extension>....................................... </Extension> </Communication> <PostalAddress> <ID/> <IDSet>... </IDSet> <Name/> <AttentionOfName/> <CareOfName/> <BuildingNumber/> <BuildingName/> <BlockName/> <StreetName/> <StreetTypeCode>normalizedString</StreetTypeCode> <Floor/> <Unit/> <StairCase/> <Door/> <PostOfficeBox/> <DeliveryPointID>normalizedString</DeliveryPointID> <PlotID>normalizedString</PlotID> <CityName/> <CitySubDivisionName/> <CountrySubDivisionCode>token</CountrySubDivisionCode> <CountryCode>token</CountryCode> <PostalCode>normalizedString</PostalCode> <Status>... </Status> <Preference>... </Preference> <GeographicalCoordinate>... </GeographicalCoordinate> <Usage>... </Usage> <Extension>....................................... </Extension> </PostalAddress> <PhysicalAddress> <ID/> <IDSet>... </IDSet> <Name/> <AttentionOfName/> <CareOfName/> <BuildingNumber/> <BuildingName/> <BlockName/> <StreetName/> <StreetTypeCode>normalizedString</StreetTypeCode> <Floor/> <Unit/> <StairCase/> <Door/> <PostOfficeBox/> <DeliveryPointID>normalizedString</DeliveryPointID> <PlotID>normalizedString</PlotID> <CityName/> <CitySubDivisionName/> <CountrySubDivisionCode>token</CountrySubDivisionCode> <CountryCode>token</CountryCode> <PostalCode>normalizedString</PostalCode> <Status>... </Status> <Preference>... </Preference> <GeographicalCoordinate>... </GeographicalCoordinate> <Usage>... </Usage> <Extension>....................................... </Extension> </PhysicalAddress> <Description/> <Note/> <TimeZoneCode>M0100</TimeZoneCode> <AvailableTimePeriod> <InclusiveIndicator>true</InclusiveIndicator> <StartDateTime></StartDateTime> <StartTime>token</StartTime> <Duration>P1Y2M3DT10H</Duration> <EndDateTime></EndDateTime> <EndTime>token</EndTime> </AvailableTimePeriod> <LocationEquipmentSpecification> <ID/> <IDSet>... </IDSet> <Property>... </Property> <Extension>....................................... </Extension> </LocationEquipmentSpecification> <EffectiveTimePeriod> <InclusiveIndicator>true</InclusiveIndicator> <StartDateTime></StartDateTime> <StartTime>token</StartTime> <Duration>P1Y2M3DT10H</Duration> <EndDateTime></EndDateTime> <EndTime>token</EndTime> </EffectiveTimePeriod> <Extension> <AnyExtension> <!--any element--> </AnyExtension> <Amount/> <Code/> <DateTime></DateTime> <ID/> <Indicator>true</Indicator> <Measure/> <Name/> <Number>1.0</Number> <Quantity/> <Text/> <Time></Time> <ValueText>string</ValueText> </Extension> </Location> <TrackingIndicator>true</TrackingIndicator> <BatchSizeQuantity>1.0</BatchSizeQuantity> <Extension> <AnyExtension> <!--any element--> </AnyExtension> <Amount/> <Code/> <DateTime></DateTime> <ID/> <Indicator>true</Indicator> <Measure/> <Name/> <Number>1.0</Number> <Quantity/> <Text/> <Time></Time> <ValueText>string</ValueText> </Extension> </BOMHeader>