InterOp:Connect/XML E-BOM/E-BOM Entities

From DocR23

The E-BOM entities defined in an InterOp XML E-BOM schema are explained below:

Entity	Mandatory Child Elements	Description
E-BOM	--	Root element of any XML file.
Document	--	A general purpose entity used to describe assembly structure as well as references to the representation(s) of an assembly component.
IssuedFrom	--	Identifies the source of the referring Document.
DocLink	--	References a Document in the context of another Document.
Exposition	--	Describes the version of the document; Parent element of the assembly structure.
Structure	--	Describes a product structure.
Root	--	Defines the structure of the main assembly.
Child	Position and RefLink	Describes an assembly component.
Position	V1, V2, ...V9 and T1, T2, T3	Describes a transformation matrix.
RefLink	Reference	Points to an assembly component definition to be instanced as the assembly component defined by the parent Child entity.
Reference	Rep and Shape	A link from an assembly component to its shape definition(s); there may be more than one shape definition.
Rep	--	Describes the shape of a component; a component may have more than one shape defined.
Shape	--	Defines the file and file type for the Shape representation.
PointsTo	--	Identifies the destination of the referenced Document.
AffectedChildren	--	When the source system has the "Assembly Cut" feature enabled, all instances associated (that is, affected by the cut feature) are listed under this element.

Contents 1 E-BOM 1.1 Mandatory Attributes 2 Document 2.1 Mandatory Attributes 2.2 Rules 3 IssuedFrom 3.1 Sub-elements 4 DocLink 5 Exposition 6 Structure 7 Root 7.1 Mandatory Attributes 7.2 Optional Attributes 7.3 Rules 8 Child 8.1 Mandatory Attributes 8.2 Optional Attributes 8.3 Mandatory Child Elements 8.4 Rules 9 Position 9.1 Mandatory Child Elements 9.2 Rules 10 RefLink 10.1 Mandatory Attributes 11 Reference 11.1 Mandatory Attributes 11.2 Mandatory Child Elements 11.3 Rules 12 Rep 12.1 Mandatory Attributes 12.2 Rules 13 Shape 13.1 Mandatory Attributes 13.2 Rules 14 PointsTo 15 AffectedChildren

E-BOM

This entity is the root element of any XML file. All other elements are contained by E-BOM.

Mandatory Attributes

• xmlns: URL where the E-BOM XML schema is to be found.
• Version: Version of the E-BOM schema used to create this file.
• xmlns:xsi: Pointer to the E-BOM schema on the W3C Web site.

Document

This entity is a general purpose entity used to describe the assembly structure as well as the references to the representation(s) of an assembly component. This entity represents the physical files.

Mandatory Attributes

• Name: Non-unique identifier.
• Identifier: Uniquely identifies an assembly node within the XML file. This Identifier matches the Identifier attribute of the corresponding Reference element. Two documents can have the same Identifier when they correspond to the same assembly node. One document corresponds to the target document and the other corresponds to the source document.
• FilePath: Full file name including path. Two documents can have same Identifier when they correspond to the same assembly node. One document corresponds to the target document and the other corresponds to the source document. The target document may or may not have a DocLink reference. If the target document does not have a DocLink reference, then the source document information is not there.
• SourceUuid: Source identifier specified by the file name without the path.
• Type: File type identifier specified by the file extension.

Rules

• Identifier attribute of an entity should be unique within the XML file.
• Document cannot be a child entity of another document.
• Only one Document in the XML file should have Root child element. That element is the main assembly definition. The other documents are assembly component definitions. They are referenced from the main assembly definition.

IssuedFrom

Identifies the source of the referring Document.

Sub-elements

• DocLink

DocLink

DocLink is used to reference a Document in the context of another Document.

Exposition

This is the Parent element of the assembly structure which describes the version of the document. Like an E-BOM node, this tag has a mandatory <version> tag.

Structure

This entity describes a product structure.

Root

This entity defines the structure of the main assembly.

Mandatory Attributes

• Name: A non-unique identifier.
• Identifier: Uniquely identifies an entity within the XML file. No two entities within the same file may have the same Identifier.

Optional Attributes

• Unit: Unit of the XML file. Refer to Units for more information.

Rules

• Root contains one or more Child entities describing the assembly component.
• Root is present in one Document per XML file only.

Child

This entity describes an assembly component. A Child may contain one or more Child sub-entities to represent sub-assemblies.

Mandatory Attributes

• Name: A non-unique identifier.
• Identifier: Uniquely identifies an entity within the XML file. No two entities within the same file may have the same Identifier.

Optional Attributes

• Visibility: This attribute is added if the child is marked "hidden" in the original assembly. The Visibility attribute is set only if its value is false.
• Suppressed: This attribute is added if the child is marked "suppressed" in the original assembly. The Suppressed attribute is set only if its value is true.

Mandatory Child Elements

• Position: A transformation matrix. It defines positioning of this Child relative to the parent entity.
• RefLink: Defines reference to the component definition.

Rules

• Position is relative to the parent entity.

Position

This entity describes a transformation matrix. The rotation part is a 3x3 matrix and is defined by sub-elements V1-V9. The translation part is a 3x1 matrix and is defined by sub-elements T1-T3. The values are formatted so that at least 12 places after the decimal point are present.

Mandatory Child Elements

• V1, V2, ...V9: 3x3 rotation matrix.
• T1, T2, T3: translation.

Rules

• Rigid translations and rotations only.
• The Position is defined relative to the parent entity.
• The Position uses long format for position elements; at least 12 digits should be used to specify the long format.
• Numbers in Position are already scaled as per the unit of the XML document. Refer to Units for more information.

RefLink

This entity points to an assembly component definition that has to be instanced as the assembly component defined by the parent Child entity.

Mandatory Attributes

• Id: Corresponds to the Identifier attribute of a Reference element. The Reference element is a part of an assembly component definition.

Reference

A link from an assembly component to its shape definition(s). There may be more than one shape definition.

Mandatory Attributes

• Name: A non-unique identifier.
• Identifier: Uniquely identifies an assembly node within the XML file. No two Reference entities within the same file may have the same Identifier. If the Reference element is used to define an assembly component, then its Identifier attribute will correspond to the Id attribute of the RefLink sub-element of the Child entity (or entities) defining the instance of this component. The Reference element Identifier attribute will also correspond to the Identifier attribute of the corresponding Document element.

Mandatory Child Elements

• Rep: Defines component shape to be used.
• Shape: Defines the file and file type for the shape representation to be used.

Rules

• All Reference elements used to define assembly components should be contained in the Document defining the main assembly.

Rep

This entity is a shape of a component. A component may have more than one defined shape. It is a part of Reference definition. It should only be created within a Reference element.

Mandatory Attributes

• Name: Identifies the type of shape used. Legal values are "DETAILED" and "LIGHT".
• Identifier: Uniquely identifies an entity within the XML file. No two entities within the same file may have the same Identifier. This Identifier matches the Identifier attribute of the Reference.

Rules

• Rep should be created as a child element only of Reference.

Shape

This entity is Part of the Reference definition. It should be created within a Reference element only.

Mandatory Attributes

• Id: Current full file name.
• Type: Current file type (that is, extension).

Rules

• Shape should be created within a Rep element only.

PointsTo

This entity is used when a Document points to an other Document. For example, the assembly Document points to the part Documents.

AffectedChildren

By default, InterOp supports "Assembly Cut" feature translation from a source system that supports this feature. All the instances that are associated with the feature are listed under this element. For more information, refer to Assembly.