Harness data xml file schema

XML schema component descriptions

The attributes or child elements for each element or type are listed in the order they appear in an XML document. Attribute names are enclosed in quotation marks and element names are enclosed in angle brackets. Each attribute or child element has a type, which is shown in italics. Attributes are listed as required or optional along with the number of times child elements can appear.

• Values for coordinates are in centimeters, which is the internal database unit for length in Autodesk Inventor.
• Computed values for attributes such as RadiusOfSmallestBend are exported as zero when they cannot be properly computed.
• The value for the BendRadiusValid attribute (a Boolean) is supplied when a bend radius value is available and bend radius checking was done. However, the value may be out of date if changes were made since the last bend radius check.
• Attributes for predefined properties such as embedded length (attribute EmbeddedLength) are not documented. These appear in the user interface for Cable & Harness, and are described in the documentation related to those items.

<HarnessData> Element

The single root element in a harness XML document.

• "Context" (string, required)

  The full file name of the top assembly document under which export is performed.

• "Version" (string, required)

  The version of the schema for the XML file, matching the Inventor version number (for example, "11.0").

• <Harness> (Harness, one)

  The complete data for the single harness that is exported. You can export data for only one harness at a time.

<Harness> Complex Type

The complete data for a single harness.

• "Name" (string, required)

  The name of occurrence of the harness assembly that is exported, for example, "HA.1234".

• "FullFileName" (string, required)

  The full file name of the harness assembly document, for example, C:\Temp\HA.1234.iam.

• <PropertyDefinition> (PropertyDefinition, zero to many)

  The custom properties defined at the harness level. These properties apply to all object occurrences in the harness, including connectors, segments, wires, and cables.

• <Library> (Library, zero or one)

  The contents of the loaded cable and harness library. This element is not present if no library is loaded.

• <PointDefinition> (PointDefinition, zero to many)

  The points used by any segment, wire, or cable occurrences in the harness.

• <ConnectorDefinition> (ConnectorDefinition, zero to many)

  The connector parts for all connector occurrences referenced by the harness.

• <Connector> (Connector, zero to many)

  The connector part occurrences referenced by the harness.

• <Segment> (Segment, zero to many)

  The segments in the harness.

• <Wire> (Wire, zero to many)

  The wire occurrences in the harness.

• <Cable> (Cable, zero to many)

  The cable occurrences in the harness.

• <Splice> (Splice, zero to many)

  The splice occurrences in the harness.

Type Simple Type

String values for types in Cable and Harness:

<PropertyDefinition> Complex Type

A definition for a custom property that is referenced by elements of type Property.

• "Name" (string, required)

  The name of the custom property, which is unique among all property definitions in each context where this type is used, for example, in the context of a cable and harness library.

• "Type" (Type, required)

  The type of the custom property, as a member of the Type enumeration.

<Property> Complex Type

A value for a custom property. At most one value can exist for a given custom property in each context where this type is used.

• "Name" (string, required)

  The name of the custom property for which the value is assigned.

• "Value" (string, required)

  The string value associated with the property referred to by the Name attribute.

<SpliceDefinition> Complex Type

A library splice definition in a cable and harness library.

• "Name" (string, required)

  The name of the library splice.

• "Category" (string, optional)
• "PartNumber" (string, optional)
• "EmbeddedLength" (string, required)

  The embedded length of the splice definition.

<PinDefinition> Complex Type

A library splice definition in a cable and harness library.

• "Name" (string, required)

  The name of the splice pin.

• "Value" (string, required)

  You cannot edit the value of the splice pin name.

<WireDefinition> Complex Type

A library wire definition in a cable and harness library.

• "Name" (string, required)

  The name of the library wire, which is unique among other library wires in a library.

• "BendRadius" (string, optional)
• "Category" (string, optional)
• "ColorStyle" (string, required)
• "CoreSize" (string, optional)
• "Gauge" (string, optional)
• "OuterDiameter" (string, required)
• "PartNumber" (string, optional)

  The values for custom properties on the library wire. The properties are defined at the library level.

<CableWireDefinition> Complex Type

A cable wire definition, which is a reference to a library wire with an additional name.

• "Name" (string, required)

  The name of the cable wire, also known as the conductor ID, which is unique among the other cable wires of a library cable.

• "Definition" (string, required)

  The name of the library wire in the same library that defines the properties of the cable wire.

<CableDefinition> Complex Type

A library cable definition in a cable and harness library.

• "Name" (string, required)

  The name of the library cable, which is unique among other library cables in a library.

• "BendRadius" (string, optional)
• "BendRadiusComputed" (Boolean, required)
• "Category" (string, optional)
• "OuterDiameter" (string, optional)
• "OuterDiameterComputed" (Boolean, required)
• "PartNumber" (string, optional)
• <CableWireDefinition> (CableWireDefinition, one to many)

  The cable wires that comprise the cable.

<TerminalDefinition> Complex Type

• "Name" (string, required)
• "RangeFixed" (string, required)

<SealDefinition> Complex Type

• "Name" (string, required)
• "RangeFixed" (string, required)

<PlugDefinition> Complex Type

• "Name" (string, required)

<LoomDefinition> Complex Type

• "Name" (string, required)
• "RangeFixed" (string, required)
• "MaxDiameter" (string, required)

<LabelDefinition> Complex Type

• "Name" (string, required)

<UserDefinedVirtualPartDefinition> Complex Type

• "Tyype" (string, required)
• "Name" (string, required)

• <Property> (Property, zero to many)

  The values for custom properties on the library cable. The properties are defined at the library level.

<Library> Complex Type

A cable and harness library, including definitions of custom properties, library wires, library splices, library virtual parts, and library cables.

• "FullFileName" (string, required)

  The full file name of the cable and harness library.

• <PropertyDefinition> (PropertyDefinition, zero to many)

  The custom properties defined at the library level, which apply to library wires and library cables.

• <SpliceDefinition> (SpliceDefinition, zero to one)

  The library splice defined in the library. Only one splice referenced in the harness is included.

• <WireDefinition> (WireDefinition, zero to many)

  The library wires defined in the library. Only library wires referenced in the harness are included, either directly by wire occurrences or by library cables that are referenced by cable occurrences.

• <CableDefinition> (CableDefinition, zero to many)

  The library cables defined in the library. Only library cables referenced in the harness are included.

• <TerminalDefinition> (TerminalDefinition, zero to many)

  The library terminals defined in the library. Only library terminals referenced in the harness are included.

• <SealDefinition> (SealDefinition, zero to many)

  The library seals defined in the library. Only library seals referenced in the harness are included.

• <PlugDefinition> (PlugDefinition, zero to many)

  The library plugs defined in the library. Only library plugs referenced in the harness are included.

• <LoomDefinition> (LoomDefinition, zero to many)

  The library looms defined in the library. Only library looms referenced in the harness are included.

• <LabelDefinition> (LabelDefinition, zero to many)

  The library levels defined in the library. Only library labels referenced in the harness are included.

• <UserDefinedVirtualPartDefinition> (UserDefinedVirtualPartDefinition, zero to many)

  The library user defined virtual parts defined in the library. Only library virtual parts referenced in the harness are included.

<Coordinates> Complex Type

The coordinates of 3D point in space or a 3D vector.

• "X" (double, required)
• "Y" (double, required)
• "Z" (double, required)

<CoordinateSystem> Complex Type

A coordinate system for a connector part occurrence, consisting of position (origin) and three vectors defining an orientation in 3D space.

• <Origin> (Coordinates, one)
• <XAxis> (Coordinates, one)
• <YAxis> (Coordinates, one)
• <ZAxis> (Coordinates, one)

<PointDefinition> Complex Type

A point in space used by one or more segments, wires, or cables in a harness. The point corresponds to a work point in the harness part document.

• "Name" (string, required)

  The name of the point, which is unique in the harness part, and corresponds to a hidden work point. These work points are not visible in the model browser. They may have the same name as work points elsewhere in the top assembly or in its components.

• <Coordinates> (Coordinates, one)

  The 3D coordinates of the point, in the space of the top assembly (global coordinates).

<OccurrencePath> Complex Type

A path to a connector part occurrence in the top assembly, used to uniquely refer to a connector part occurrence when no reference designator is available.

• <Occurrence> (anonymous, one to many)

  A list of assembly occurrences leading to the connector part occurrence, from top down, ending with the connector part occurrence itself. The anonymous complex type has a single required Name attribute of type string indicating the occurrence name.

<WirePin> Complex Type

A terminating pin for a wire occurrence or cable wire occurrence.

• "ConnectorRefDes" (string, optional)

  The reference designator of the connector part occurrence to which the wire pin is connected. This is not present if there is no connector part occurrence.

  If the connector is a splice, the reference designator of the splice is used.

• "ConnectorPin" (string, optional)

  The name of the pin on the connector part occurrence to which the wire pin is connected. This is not present if there is no connector pin (or part).

  If the connector pin is a splice pin, the name of the splice pin is used.

• "Point" (string, required)

  The named point in space corresponding to the location of the wire pin.

• <OccurrencePath> (OccurrencePath, zero or one)

  The unique path to the connector part occurrence to which the wire pin is connected. This is not present if there is no connector part occurrence.

  If the wire connects to a splice pin, no occurrence path is shown under the connector pin section.

<RouteSegment> Complex Type

A reference to a segment through which a wire or cable is routed, including the route direction.

• "Segment" (string, required)

  The name of the segment being routed through.

• "Forward" (Boolean, required)

  Whether the wire or cable is being routed through the segment in the same order as the segment points ("1") or the opposite direction ("0").

<PinDefinition> Complex Type

An electrical pin on a connector part.

• "Name" (string, required)

  The name of the pin, which is unique among the other pins on the connector part.

• "EmbeddedLength" (string, optional)
• <Coordinates> (Coordinates, one)

  The 3D coordinates of the pin, in the space of the containing connector part.

• <Property> (Property, zero to many)

  The values for custom properties on the pin. The properties are defined at the connector part level.

<ConnectorDefinition> Complex Type

A connector part, which is used as a definition for connector part occurrences.

• "FullFileName" (string, required)

  The full file name of the connector part document.

• <PropertyDefinition> (PropertyDefinition, zero to many)

  The custom properties defined at the connector level, which apply to the connector part and its pins, but not connector part occurrences or pin occurrences.

• <PinDefinition> (PinDefinition, zero to many)

  The pins contained in the connector part.

• <Property> (Property, zero to many)

  The values for custom properties on the connector part. The properties are defined at the connector part level (above).

<Pin> Complex Type

An occurrence of a pin on a connector part occurrence.

• "Definition" (string, required)

  The name of the pin on the connector part definition on which the pin occurrence is based.

• "EmbeddedLength" (string, optional)
• <Coordinates> (Coordinates, one)

  The 3D coordinates of the pin occurrence, in the space of the top assembly (global coordinates).

• <Property> (Property, zero to many)

  The values for custom properties on the pin occurrence. The properties are defined at the harness level.

<Connector> Complex Type

An occurrence of a connector part.

• "RefDes" (string, optional)

  The reference designator of the connector part occurrence, which overrides the connector part definition reference designator.

• "Definition" (string, required)

  The full file name of the connector part on which this connector part is based.

• "EmbeddedLength" (string, optional)
• <OccurrencePath> (OccurrencePath, one)

  The unique path to the occurrence from the top assembly.

• <CoordinateSystem> (CoordinateSystem, one)

  The coordinate system of the connector part occurrence, relative to the top assembly.

• <Pin> (Pin, zero to many)

  The pin occurrences contained in the connector part occurrence.

• <Property> (Property, zero to many)

  The values for custom properties on the connector part occurrence. The properties are defined at the harness level.

<Segment> Complex Type

A segment in the harness through which wires or cables may be routed.

• "Name" (string, required)

  The name of the segment, which is unique in the harness.

• "BendRadius" (string, optional)
• "BendRadiusComputed" (Boolean, required)
• "BendRadiusValid" (Boolean, optional)
• "Class" (string, optional)
• "ColorStyle" (string, required)
• "Diameter" (string, optional)
  Note: If the diameter of a segment is being computed, but there are no wires or cables routed through it, then the diameter is reported as the custom value.
• "DiameterComputed" (Boolean, required)
• "Length" (string, required)
• "LengthAdjusted" (string, required)
• "MaxDiameter" (string, optional)
• "MaxPercentFull" (string, optional)
• "RadiusOfSmallestBend" (string, required)
• "ServiceLoop" (string, optional)
• <Point> (anonymous, one to many)

  A list of the named points in space defining the segment, in order. The anonymous complex type has a single required Definition attribute of type string indicating the name of the point.

• <Property> (Property, zero to many)

  The values for custom properties on the segment. The properties are defined at the harness level.

<Wire> Complex Type

A wire occurrence in the harness. Also used for cable wire occurrences.

• "Name" (string, required)

  The name of the wire occurrence, which is unique in the harness.

• "Definition" (string, required)

  The name of the library wire on which the wire occurrence is based. For a cable wire occurrence, this is the cable wire definition name (conductor ID).

• "BendRadius" (string, optional)
• "BendRadiusValid" (Boolean, required)
• "Class" (string, optional)
• "Length" (string, required)
• "LengthAdjusted" (string, required)
• "MaxLength" (string, optional)
• "RadiusOfSmallestBend" (string, required)
• "SeparationCode" (string, optional)
• <Pin1> (WirePin, zero or one)

  The starting ("from") pin occurrence for the wire. This is not present for an unterminated cable wire.

• <Pin2> (WirePin, zero or one)

  The ending ("to") pin occurrence for the wire. This is not present for an unterminated cable wire.

• <RouteSegment> (RouteSegment, zero to many)

  The segments through which the wire is routed.

• <Property> (Property, zero to many)

  The values for custom properties on the wire. The properties are defined at the harness level.

<Cable> Complex Type

A cable occurrence in the harness.

• "Name" (string, required)

  The name of the cable occurrence, which is unique in the harness.

• "Definition" (string, required)

  The name of the library cable on which the cable occurrence is based.

• "BendRadius" (string, optional)
• "BendRadiusComputed" (Boolean, required)
• "BendRadiusValid" (Boolean, required)
• "Length" (string, required)
• "LengthAdjusted" (string, required)
• "RadiusOfSmallestBend" (string, required)
• <CableWire> (Wire, one to many)

  The cable wires in the cable, defined in the same way as wire occurrences.

• <Property> (Property, zero to many)

  The values for custom properties on the cable. The properties are defined at the harness level.

<Splice> Complex Type

A splice occurrence in the harness.

• "Name" (string, required)

  The name of the splice occurrence. Unique in the harness.

• "Definition" (string, required)

  The name of the splice library.

• "Coordinates" (Coordinates, one)

  The 3D coordinates of the splice, in the space of the top-level assembly (global coordinates).

• <Property> (Property, zero to many)

  The values for custom properties on the splice. The properties are defined at the occurrence level.

• <Pin> (Pin, two)

  The pin occurrences contained in the splice. A splice occurrence contains two pins named 1 and 2.

<Terminal> Complex Type

A terminal occurrence in the harness.

• "Name" (string, required)

  The name of the terminal occurrence. Unique in the harness.

• "Definition" (string, required)

  The library name of the terminal occurrence.

<Seal> Complex Type

A seal occurrence in the harness.

• "Name" (string, required)

  The name of the seal occurrence. Unique in the harness.

• "Definition" (string, required)

  The library name of the seal occurrence.

<Plug> Complex Type

A plug occurrence in the harness.

• "Name" (string, required)

  The name of the plug occurrence. Unique in the harness.

• "Definition" (string, required)

  The library name of the plug occurrence.

<Label> Complex Type

A label occurrence in the harness.

• "Name" (string, required)

  The name of the label occurrence. Unique in the harness.

• "Definition" (string, required)

  The library name of the label occurrence.

<Loom> Complex Type

A loom occurrence in the harness.

• "Name" (string, required)

  The name of the loom occurrence. Unique in the harness.

• "Definition" (string, required)

  The library name of the loom occurrence.

<UserDefinedVirtualpart> Complex Type

A user-defined virtual part occurrence in the harness.

• "Name" (string, required)

  The name of the user-defined virtual part occurrence. Unique in the harness.

• "Definition" (string, required)

  The library name of the user-defined virtual part occurrence.