PLMXML Schema The 'id' attribute is used for references between elements. It should not be use to encode other information. sdkname=IdObject plm:anyURIType is used in place of xsd:anyURI, since we want to allow filenames as well as genuine URIs. The ApplicationRef element is meant to relate the parent element (Part, Representation, etc) back to the owning entity in the sending application. Attributes: application: the context in which the contents of the label and version attributes make sense. Whether this field includes an application version number is up to the application, as long as it starts with something identifiable to the sending application. label: the string which identifies the application entity - the value of this field is only meaningful to the sending/authoring application. The receiving application can compare the contents of the attribute to test if two entities are the 'same' entity. But the actual value is meaningless to the receiving application. version: the optional string attribute which identifies the version of the application entity. This attribute can only be used to test if the versions of an entity are the same (i.e. the test is only meaningful if the label attribute values are the same). No version ordering can be deduced from the value. Similar to the label attribute, the version attribute contents are meaningless to the receiving application. sdkname=DescriptionObject The DescriptionBase type is an abstract base type for PLM XML types which have optional description and ApplicationRef. Sub-elements: Description Readable textual description of the element. ApplicationRef A means of uniquely identifying the element in terms understood by the sending system. More than one is allowed (at most one per Application). This is a legacy box type. The 'Bound' element should be used. output=ignore This is a legacy sphere bound type. The 'Bound' element should be used. output=ignore This is a box or sphere-shaped bound in 3-space. Attributes: type: 'box' or 'sphere' values: 6 or 4 doubles. If a box, these are the coordinates of the centre, followed by xwidth/2, ywidth/2, zwidth/2. If a sphere, these are centre, radius. transformRef: Optional transform, to achieve non-aligned boxes. SubElements: Transform: Optional transform. output=ignore output=ignore output=ignore output=ignore The Attribute element is an abstract element. Useful attributes (ones that include fields) must be derived from the Attribute element defined within this schema. The derived attributes will define their data elements to represent data fields. The derived attributes also need to be set as 'equivalent' to the Attribute element. This enables the new derived attribute to be inserted into documents wherever the Attribute element is allowed. Base class for elements which have PLMXML Attributes, i.e. elements derived from plm:AttributeBase. Attributes: attributeRefs: reference to Attributes SubElements: Attribute: any element derived from AttributeBase. Base class for elements which may contain 3D bounds. SubElements: BoxBound: legacy, use Bound in preference SphereBound: legacy, use Bound in preference Bound: 3D bound sdkname=Entity3D output=ignore output=ignore This is an abstract base class for elements which require information such as access control, status and checkout information Attributes: accessRefs: reference to one or more elements derived from AccessControlBase statusRef: reference to element derived from StatusBase checkoutRefs: reference to one or more elements derived from CheckoutStatusBase AccessControl - abstract base class for Access Control types. Status - abstract base class for status information types. CheckoutStatus - abstract base class for Checkout types. Base class for elements which reference an external entity such as a face in an XT file. Attributes: entityRef: reference to external entity. sdkname=EntityObject Base class for elements representing 3D points. Attributes: position: coordinates of point Base class for elements representing parametrised curves in 3-space. Attributes: startT: start parameter endT: end parameter SubElements: StartPoint: optional coordinates of start point EndPoint: optional coordinates of end point SamplePoints: optional coordinates of a sequence of points along curve Base class for 3D curves which lie in a plane. Attributes: origin: centre of plane zAxis: normal to plane xAxis: x-direction in plane Base class for elements representing a u-v-parametrised surface in 3-space. Attributes: startU: lowest U value endU: highest U value startV: lowest V value endV: highest V value SubElements: SamplePoints: optional coordinates of a set of points on the surface Base class for elements representing a surface which uses an X-Y-Z coordinate frame as part of its definition. Attributes: origin: origin of coordinate frame zAxis: Z Axis of coordinate frame xAxis: X Axis of coordinate frame Type representing a Red-Green-Blue colour. Type representing a colour in Red-Green-Blue-Alpha format. Element representing a material type. Attributes: name: descriptive name ambient: ambient colour diffuse: diffuse colour specular: specular colour emissive: emissive colour shininess: shininess coefficient alpha: alpha coefficient Element used to associate an entity with a material (colour). Attributes: materialRef: IDREF to the material element. SubElements: EntityRef: Element derived from EntityRef, used to specify which entity is to be associated with the material. Base class for elements representing Light Sources Attributes: name: descriptive name ambient: ambient light diffuse: diffuse light specular: specular light intensity: intensity multiplier Directional Light Source (from infinity) Attributes: direction: direction TO the light source. Positional Light Source, i.e. point source. Attributes: position: position of light direction: direction in which the light is shining cutoffAngle: semiAngle of cone of light. If absent, the source is not a spotlight, but shines in all directions. intensityExponent: the intensity exponent determines the intensity distribution within the cone. Higher intensity exponent values result in a more focused light source. attenuation: the attenuation of the light source within the scene. The three attenuation values are the factors in a quadratic equation, giving intensity as a function of distance from the source. The values within the attribute are in order: quadratic, linear and constant. This type describes whether the PLMXML reference is specifying a single entity or a set of entities. Base class for defining a reference to an entity. All entity reference elements should be based on this type and defined as a substitution class for EntityRef. Attributes: name: Name of the reference select: Type of the reference - single or multiple. contextRef: Context for the reference Locator reference format. Locator reference element. The reference is a URI based reference and the syntax of the URI must be pre-defined. Hence the only predefined type is currently PLMXMLPointer. Attributes: locationRef: The value of the URI reference. type: Format of the locator reference. Attribute reference element. The reference is based on a user defined named attribute on the host representation. This type enables the author to note the attribute name, field name/index and the value of the attribute. Attributes: attribute: The name of the attribute to query, e.g. "COMPANYNAME/Tracking_attribute". field: The name of the field within the attribute. index: The index of the field within the attribute, if its name is not given. (The first field is index 0). value: The value of the attribute to match. GUID reference element. This simply specifies the GUID of the entity being referenced. Attribute: guid: The GUID of the entity referenced, in the form of a string containing 32 hex digits, with arbitrary non-hex spacing characters. This abstract datatype describes a single feature within the feature tree hierarchy. The feature description contains basic information such as name and type, as well as information to link the feature to the originating application. Parameter descriptions can also be included in the feature description. Attributes: name - (required) display name for the feature nextFeature - (optional) the XML id of the next feature in the feature hierarchy. targetFeature - (optional) the XML id of the target feature that this feature relies on. The target feature defines which feature forms the resultant entity. toolFeature - (optional) the XML id of the tool feature that this feature relies on. suppressed - (default=false) TRUE if the feature is suppressed in the feature tree. editable - (default=false)) TRUE if any parameters of the feature may be edited. Elements: Type - (1) element describing the type of feature. This is an application specific type. The receiving application is not meant to deduce or interpret the type but could use it to classify or group the feature. Parameter - (0 or many) elements to describe the parameters associated with the feature. It is up to the application to decide what parameters to exchange or describe within the feature description. EntityRef - (0 or many) references to entities on another representation (e.g. a BRep) expressed as PLMXML references. Generic feature element which can be used to enumerate 'any' parameterised feature. No semantic or specialised information is exchanged via this schema. This datatype describes a feature hierarchy for feature based modelling system. The feature hierarchy is represented via a single linked list of set of feature elements that reference the next feature in the hieratchy. The linked list hierachy must describe the features in 'replay' order (ie. first operation first in the hierachy). There is scope to describe 'tree-like' dependencies via additional 'dependentFeatures' reference attributes. The feature tree is represented within PLMXML as an 'Internal Representation' of a part - the FeatureTreeType is based on InternalRepBase and the element FeatureTree is a substitution class for InternalRep. Attributes: name - (required) display name for the feature tree. firstFeature - (optional) the XML id of the first feature in the feature hierarchy. editable - (optional) TRUE if any features of the feature tree may be edited. Elements: Type - (1) element describing the type of feature tree. This is an application specific type. The receiving application is not meant to deduce or interpret the type but could use it to classify feature tree. Feature - (0 or many) the list of features thaat make up the feature tree. Reference Point element Straight line curve. Attributes: origin: start (T=0). direction: direction of increasing T. Polyline, i.e. sequence of connected line-segments. Attributes: closed: true if the end of the polyline equals its start. SubElements: Points: coordinates of the ends of the line segments, in order. Circular curve. The T=0 point is on the positive x-axis of the underlying plane. The T=pi/2 point is on the positive y-axis. Attributes: radius: radius Elliptical curve. The T=0 point is on the positive x-axis of the underlying plane, at a distance 'majorRadius' from the origin. The T=pi/2 point is on the positive y-axis, at a distance 'minorRadius' from the origin. Attributes: majorRadius: major radius. minorRadius: minor radius. B-Spline curve in 2- or 3-dimensional space. Attributes: degree: degree of the curve. dimension: dimension of the curve. This determines the length of each vector in 'Vertices': if isRational is true, it is 'dimension+1', else it is 'dimension'. Defaults to 3. isRational: true if the spline is rational. isPeriodic: true if the spline is periodic. isClosed: true if the start and end of the curve coincide. form: form of the curve. SubElements: Knots: knot values, in increasing order, no repetitions. KnotMultiplicities: multiplicities of the knots. Vertices: coordinates of the vertices. Composite Curve, formed by joining curves together end-to-end. Attributes: curves: sequence of curves. NB this attribute name is non-standard, PLMXML conventions require that IDREFS attributes end in 'Refs'. isClosed: true if the end of the last curve coincides with the start of the first. A curve defined in the parameter-space of a surface. The x,y positions of the curve correspond to u,v parameters in the surface. Attributes: parameterCurve: reference to a 2-dimensional BSpline curve. surface: reference to a surface. NB both these attributes have non-standard names, PLMXML conventions require reference attributes to end in 'Ref'. Conical surface. The cone axis is along the Z-Axis of the underlying coordinate frame. The cone radius increases in the direction of the Z-Axis. Attributes: radius: radius of the cone at the origin of the coordinate frame. This is zero or positive. halfAngle: the positive angle between the Z-Axis and a line in the cone, in radians. Toroidal surface. The axis of the torus is the Z-Axis of the underlying coordinate frame. Attributes: majorRadius: major radius minorRadius: minor radius B-Spline surface, normally in 3-dimensional space. Attributes: uDegree: degree of the surface in U. vDegree: degree of the surface in V. dimension: dimension of the surface. This determines the length of each vector in 'Vertices': if isRational is true, it is 'dimension+1', else it is 'dimension'. Defaults to 3. isRational: true if the surface is rational. isUPeriodic: true if the surface is periodic in U. isUPeriodic: true if the surface is periodic in U. isVClosed: true if the surface is closed in V. isVClosed: true if the surface is closed in V. numberOfUVertices: number of U vertices. numberOfVVertices: number of V vertices. SubElements: UKnots: U knot values, in increasing order, no repetitions. VKnots: V knot values, in increasing order, no repetitions. UKnotMultiplicities: multiplicities of the U knots. VKnotMultiplicities: multiplicities of the V knots. Vertices: coordinates of the vertices. Planar Coordinate system. Geometry composition. SubElements: Point: any elements derived from Point. Curve: any elements derived from Curve. Surface: any elements derived from Surface. CoordinateSystem: coordinate systems. Top level construction geometry element. SubElements: Point: any elements derived from Point. Curve: any elements derived from Curve. Surface: any elements derived from Surface. CoordinateSystem: coordinate systems. GeometryComposition: geometry compositions. Defines a perspective view from a point. Toroidal surface. The axis of the torus is the Z-Axis of the underlying coordinate frame. SubElements: ViewFrom: eye point ViewTo: point towards which eye is looking ViewVertical: vector which is vertical in the view. Should be perpendicular to (ViewFrom - ViewTo). Defines a view from infinity (no perspective). SubElements: ViewDirection: direction eye is looking in. ViewVertical: vector which is vertical in the view. Should be perpendicular to ViewDirection. ViewTo: optional point at which eye is looking, only needed if depth is significant in the view. Defines a view, i.e. a camera position and optional viewport. SubElements: One of Perspective, Orthographic or ViewMatrix (4 by 4). ViewPort: optional viewport definition. Basic texture data format definition Determines the length of each data element in the hexBinary data element. RGBA = 4 bytes of red, green, blue and alpha RGB = 3 bytes of red, green and blue LA = 2 bytes of luminance and alpha A = 1 byte of alpha L = 1 byte of luminance Basic 1D texture data definition Basic 2D texture data definition Basic texture data definition Texture control definition Basic texture definition Texture coordinates Texture structures that can be associated with a remote entity. This class represents the 'CompoundRep' element in a PLMXML file. Attributes: location: URI of data source load: True if data is to be loaded at the same time as the PLMXML file. format: Data format. If this is absent, the format is taken from the parent Representation. Part Representation. The Representation element in an PLMXML file refers to a model in some particular format, such as XT or jXT. It can refer to the model data in another file (an External Representation), or the data can be embedded within the Representation element in the XML file (an InternalRepresentation). Attributes: name: descriptive name format: data format revision: revision of data transformRef: optional reference to a Transform which positions the data in the coordinate frame of the part. location: URI of data source load: true if data is to be loaded at the same time as the PLMXML file. equivalentRef: an optional reference to a Representation which is equivalent to this one (for example, has the same shape). If this attribute is used, then it should collect together equivalent Representations of a Part into a ring, with each Representation using this attribute to point to the next in the ring. SubElements: Transform: see transformRef. CompoundRep: the Representation may not have a single location. Instead, it may contain a number of CompoundRep sub-elements, each with its own location. The representation is the aggregate of these data sources. InternalRep: the Representation may contain one element derived from InternalRep, in which case it should not also have a location attribute. May contain elements of type Material, EntityMaterial, TextureData, Texture, or EntityTexture. Occurrence. An Occurrence specifies a usage of a Part in an Assembly, by specifying a chain of Instances which lead from the Assembly down to the Part, or by a chain of Instances and other Occurrences, which when joined together define an Instance chain. It is also possible for an Occurrence to reference a ProductView at the end of its Instance chain, rather than a Part. The Assembly, which is the parent of the first Instance in the Instance chain, is called the 'top Part' of the Occurrence. The Part, which is instanced by the last Instance in the Instance chain, is called the 'bottom Part' of the Occurrence. Attributes: name: descriptive name instanceRefs: chain of Instances which define the Occurrence. pathRefs: chain of Instances and Occurrences which, when joined together, define an Instance chain. Only one of instanceRefs and pathRefs should be present. transformRef: an optional reference to a Transform which overrides the transform obtained by accumulating the transforms in the Instance chain. In other words, it specifies the position of the Part in the coordinate frame of the Assembly. partRef: an optional Part to use in place of the 'bottom Part'. representationRefs: an optional collection of Representations. If present, these are to be used in preference to any Representations the Part may have itself, or which may be referenced by the last Instance in the chains. They would normally be different format representations of the same shape. materialRef: reference to a Material element to use when displaying the Part in the position defined by this Occurrence. geometryRefs: optional geometry associated with this Occurrence. occurrenceRefs: an Occurrence may have a number of 'child' Occurrences, which this attribute specifies. A child Occurrence must have an Instance chain which is the same as that of its parent, but with one more Instance added at the bottom end. An Occurrence is normally only rendered in a view if it has no child Occurrences. alternativeOfRef: It is possible for one ProductView to be defined by reference to another ProductView. In this case the first ProductView will contain some Occurrences which override Occurrences in the referenced ProductView. The 'alternativeOfRef' attribute is used to indicate the Occurrence which this Occurrence is overriding. If an Occurrence has an alternativeOfRef attribute, it should not also have an instanceRefs attribute, nor should it have an occurrenceRefs attribute. productViewRef: If an Occurrence has a productViewRef, then it is regarded as an Occurrence of that ProductView, not of its 'bottom Part'. In this case, the 'top Part' of the ProductView must be the same as the 'bottom Part' of the Occurrence. visible: Flag to indicate the Occurrence is visible. If absent, visible is implied. An Occurrence which references another Occurrence via the alternativeOfRef attribute may override its visibility, i.e. make it visible if invisible or vice-versa. SubElements: Transform: see transformRef above. Representation: see representationRefs above. Material: EntityMaterial: Allows the association of a Material with an entity; for example the Occurrence could specify the colour of a face of a body. The entity should be in a Representation specified by this Occurrence, or by the last Instance in the Instance chain, or by the Part of the Occurrence. ProductView. This is a collection of Occurrences of Parts within one Assembly, i.e. it selects certain Occurrences, for example in order to display them. All the root Occurrences (given by primaryOccurrenceRef or rootRefs) must have the same 'top Part'. This is called the 'top Part' of the ProductView. Attributes: name: descriptive name primaryOccurrenceRef: ) These two attributes are used to specify the root rootRefs: ) Occurrences, i.e. those which are not children of other Occurrences in this ProductView. If there is only one root, either attribute may be used. If there is more than one root, rootRefs must be used. viewControlRef: optional reference to a ViewControl displayControlRef: optional reference to a DisplayControl alternativeOfRef: A ProductView may be defined by reference to another ProductView, in which case it may include Occurrences which override certain corresponding Occurrences in the other ProductView. This attribute is used to specify other ProductView, which must have the same 'top Part' as this one. SubElements: Occurrence: the Occurrences in the ProductView. Transform: Transforms which may be referenced by the Occurrences. sdkname=PartType Instance, i.e. usage of a Part by an Assembly, with optional Transform. Attributes: name: descriptive name. quantity: Quantity of the element referenced. If absent, 1 is implied. If present, any contained or referenced Transform is ignored. unitRef: Units for the quantity attribute. If absent, 'each' is implied. An IDREF to a 'Unit' element. instanceType A 'subtype' string for the instance. No specified semantics. sequenceNumber Serves to identify the instance within its referencing Part. If present, should be unique within the parent. transformRef: optional Transform which positions the Part in the coordinates of the Assembly. materialRef: optional Material for use when rendering this Instance. partRef: Part being instanced. This should only be used by an 'Instance' element, not one of its derived elements. representationRefs: an optional collection of Representations. If present, these are to be used in preference to any Representations the Part may have itself. They would normally be different format representations of the same shape. SubElements: Transform: see transformRef. (This should not be used in conjunction with transformRef). InstanceGraph. This is an element used as a container for Parts and Instances which form some or all of an assembly graph. Attributes: rootInstanceRef: if the graph of Instances and Parts in the InstanceGraph has a single root, which is an Instance, this may be use to indicate it. rootRefs: however, in general there may be more than one root, and the roots may be Instances or Parts. The use of this attribute to specify the root(s) is preferred. viewControlRef: optional reference to a ViewControl displayControlRef: optional reference to a DisplayControl SubElements: May contain Instances, Parts, or any element derived from Instance, Part, Structure or StructureRevision. May also contain Transforms which may be referenced by Instances. StructureDef. This element may contain one or more InstanceGraphs, representing all or part of one or more assembly graphs. It also contains elements relating to its display. Attributes: name: descriptive name. revision: revision. revisionRuleRef: reference to a RevisionRule which was used to generate this assembly from an Unconfigured Product Structure. variantRuleRef: reference to a VariantRule which was use to generate this assembly. NB: these elements are not defined in this schema. SubElements: This element may contain Representations, DisplayControls, ViewControls, Light Sources, ProductViews, Materials, ConstructionGeometry, Parts, or InstanceGraphs. ProductDef. Basic types that can be represented by user value entries and tables. int = Data entity is an integer ints = Data entity is a list of integers real = Data entity is a real reals = Data entity is a list of reals boolean = Data entity is a boolean (true/false) booleans = Data entity is a list of booleans reference = Data entity is a reference (anyURI) enum = Data entity is an enumeration. list = Data entity is a list item. This element defines a single entry in a UserList. The 'value' attribute must contain data of the type specified by the 'type' attribute in the owning list. Attributes: value: data value (required). description: textual description of the value. This element defines a list of user specified data items. Each item in the list is of the same type - as specified by the 'type' attribute'. Attributes: name: descriptive name type: type of data items, i.e. int, ints, etc. SubElements: Item: One element per data item. (At least one). sdkname=UserValue This element defines a single title/value pair in a UserData table. Attributes: title: name of this entry in the table. value: value of the entry. type: datatype of the value - int, ints, real, reals, boolean, booleans, string, reference, enum or list. format: editable: false if this value should not be modified by the receiving application. dataRef: If type is 'enum' or 'list', then a UserList element should be specified either by dataRef, or by being included as a sub-element. In the 'enum' case, the UserList gives the valid values of the enum; in the 'list' case, 'value' is ignored and the UserList IS the value of this entry in the table. minInclusive: Minimum value allowed (inclusive). minExclusive: Minimum value allowed (exclusive). maxInclusive: Maximum value allowed (inclusive). maxExclusive: Maximum value allowed (exclusive). stepValue: Allowed values go from min to max in steps of 'stepValue'. minLength: Minimum list length allowed (only for type="list"). maxLength: Maximum list length allowed (ditto). SubElements: UserList: May contain a single UserList element (see dataRef above). The UserData element is a PLMXML Attribute used to represent a table of title/value pairs. It is up to communicating applications to agree on the meaning of these tables. UserData is based on the plm:Attribute base class so that it may be substituted wherever PLMXML Attributes are permitted. Attributes: type: A string giving the type of UserData. No specified values. SubElements: UserValue: One element per entry in the table (at least one). sdkname=UserEnum This element represents a user defined enumeration value. Attributes: value: the enum value (required). listRef: reference to a UserList element which gives the valid values in the enum. 'value' must be one of these values. This class represents the <XTData> element in a PLMXML file, which is used to embed XT files in a Representation element, for example: <Representation ...> <XTRep> <XTData>T51 : TRANSMIT FILE created by modeller version 130021217 SCH_1300212_130060 12 1 63 2 3 0 0 0 0 1e3 1e-8 0 0 0 1 0 1 1 4 5 6 7 8 9 10 81 1 2 63 11 1 0 0 0 0 1 ... </XTData> </XTRep> </Representation> XT Representation component of the PLMXML Schema sdkname=GramsMillimetres sdkname=GramsCentimetres sdkname=KilogramsMetres sdkname=PoundsFeet sdkname=PoundsInches PLMXML Attribute describing mass properties. ChildElementOccurrences=1 Request identifier. The abstract datatype and element for Query elements. The element describing the data context for PLMXML request. This effectively identifies the part or application context for the request. Attributes: name: (optional) name of the data context or part. format: (required) the format of the context. context: (required) the location or identifier of the data context. NB the name is 'context', not 'contextRef'. SubElements: Query (required) the query itself. Note that this is an abstract element, so a substitution element must be used. sdkname=DocumentBase This class corresponds to a top-level element in a PLMXML file. Document and RequestDocument are derived classes of this, which correspond to 'PLMXML' and 'PLMXMLRequest' elements, respectively. Attributes: author: Author. date: Date modified. time: Time modified. language: Language used, e.g. in comments. schemaVersion: Version of the schema this file was written for, e.g. "2.0". The main PLMXML data request element. This element must appear within it's own document. The element contains a number of fields for describing the context of the request (e.g. the part name, etc) and the type of data to be returned. The application making the request provides it's own context within the data request element via the 'requestId' attribute. This attribute value must be returned in the resultant PLMXML document. This enables the application to match PLMXML documents with the data request. Attributes: application: (mandatory) Name of the application making the request. requestId: (mandatory) Application supplied identifier for the request. This value will be returned in the resulting PLMXML document. Elements: Request: (optional) The application part context and request. sdkname=RequestDocument This type gives the parameters which control a facet generation operation. Attributes: curveAngularTol: max angular change between chords along edge curveDistanceTol: max edge/chord distance surfaceAngularTol: max angular change between facets surfaceDistanceTol: max face/facet distance tristripControl : whether tristrips allowed facetsetControl: whether facetsets are created per face, per material, or unspecified This datatype is used to describe a representation query. The element is defined as a substitution element for the abstract Query element. Attributes: type: (required) The type of representation requested. Currently, this is : XT, JT, jXT or All label: (optional) If a suitable application label is specified the request must return the representation matching the specified label. If no label is specified, then the request must return a PLMXML document that identifies all the appropriate representations in the specified context. This datatype is used to describe a product structure query. The element is defined as a substitution element for the abstract Query element. This datatype is used to describe a Feature/FeatureTree query. The element is defined as a substitution element for the abstract Query element. Attributes: label: (optional) If a suitable application label is specified the request must return the feature matching the specified label. If no label is specified, then the request must return an PLMXML document that specifies the whole feature tree within the specified context. This datatype is used to describe an Annotation query. The element is defined as a substitution element for the abstract Query element. Attributes: label: (optional) If a suitable application label is specified the request must return the annotation matching the specified label. If no label is specified, then the request must return an PLMXML document that specifies all the annotations within the specified context. The request return types. This datatype is used to return status information to the user within the resultant PLMXML document. The element is in the form of a PLMXML attribute. This implies that an PLMXML docuemnt could just be returned with one RequestInformation element in it - useful for returning errors and no data. Attributes: requestId: (required) The application request identifier. result: (default=Success) Indicates success or failure with a code. description: (optional) textual description of failure, etc. The redline markup element for PLMXML - is a simple annotation type that describes its textual data via the xhtml spec. Thus the text can include format and font information as per a normal html document. The redline element(s) is defined via simple polyline geometric element and references to related entities can be made via the 'EntityRef' element. output=ignore This defines the type of the outermost element in a PLMXML file. This schema definition, in W3C format, can represent the following data in various combinations and permutations : Product definition via instance graph and occurrence view representations Part representation via facet representation and/or external refs to XT files Attribute information sdkname=Document This is a base type for objects which can be revisioned and support hierarchical, configurable structure. Attributes: name: Descriptive name optionRefs: Options. Each Option gives the full set of allowed values for this product. ProductRevisions may specify an Option with a sub-set of allowed values. subType: A 'sub-type' string. No specified semantics. This can be used where simple customised sub-types have been defined and a full PLMXML schema extension is not appropriate. releaseStatusRefs: Reference to one or more ReleaseStatus elements, which give release dates and effectivities. This is a revision of a Structure. Attributes: name: Descriptive name revision: Identifies the revision. Could be numeric, alphabetic, or a mixture. version: Gives the current 'version' of this revision. The version captures changes en route to the next revision of this Product. masterRef: Reference to the Structure of which this is a version. optionRefs: Options. Each Option gives the set of allowed values for this StructureRevision. releaseStatusRefs: Reference to one or more ReleaseStatus elements, which give release dates and effectivities. instanceRefs: Reference to elements derived from StructureInstance, which define the hierarchical structure. Both StructureRevision and StructureRevisionView can have instanceRefs. In the case of StructureRevision, the element is then representing a 'default' or 'unspecified' view. subType: See Structure. simplifiedRepRefs: If an assembly has replacement representations (that is, in case the assembly structure is not important in some context, then the replacement representations can be used). Elements: VariantDefault VariantRuleCheck This is a base type for elements representing a 'view' (design, manufacturing, etc) of a StructureRevision. Attributes: name: descriptive name revisionRef: Specifies the StructureRevision of which this is a view. viewRef: A reference to a view element (e.g. 'design') instanceRefs: if an assembly, these are the Instances it references Part. This is used in the representation of configured product structure. Attributes: representationRefs: Representations of the Part. materialRef: an optional Material for use when displaying the Part. preferredUnits: the units preferred when presenting this Part to the user. Note that this does NOT affect any numerical values representing lengths in the PLMXML file - these are always in metres. geometryRefs: geometry elements referenced by the Part. annotation3DGroupRefs: reference to any 3D Annotation groups associated with the Part. (note: these are not defined within this schema). type: assembly, minimal, wire, solid, sheet or general. partRefs: if an assembly, it is also possible to 'instance' other Parts directly without the need for an actual Instance element. However this is limited to cases where information stored on the Instance (such as Transform) is not required. SubElements: Representation: see representationRefs. Occurrence: if an assembly, this Part may have certain Occurrences singled out, so that, for example, they can have different Materials associated, or can be repositioned. sdkname=Part This is the revision-independent Product, derived from Structure. It corresponds to the STEP 'product'. Attributes: productId: The identifier of the Product, unique in some context, e.g. an Organisation. alternateForRef: An 'alternate' Product is one which is substitutable, in all contexts, for a particular Product. If this is an 'alternate' Product, then this attribute references the Product for which this is an alternate. This is a revision of a Product. It corresponds to STEP 'product_definition_formation'. This is a 'view' (e.g. 'design', 'manufacturing', 'maintenance') of a revision of a Product. Attributes: releaseStatusRefs: Reference to ReleaseStatus elements giving release date and effectivity information for this revision. This is a 'view' (e.g. 'design', 'manufacturing', 'maintenance'). Referenced by a ProductRevisionView. Corresponds to iMAN 'BOMView'. Attributes: name: Name of the view (e.g. 'design'). A base type for instancing relations between Structure, StructureRevision and StructureRevisionView elements. Attributes: instancedRef Reference to instanced element. This should be derived from StructureRevisionView, StructureRevision, or Structure. In the latter cases some other context must determine which view or revision is intended. effectivityRefs Reference to effectivity elements. SubElements: VariantCondition: An optional VariantConditions An Instance between Product, ProductRevision, or ProductRevisionView elements. Attributes: substituteForRef: A ProductInstance may be a 'substitute' for another, which means that it may be used instead, but only in the context of their common parent assembly. If this is a substitute for another ProductInstance, then this attribute references it. This element acts as a context for effectivities. An Effectivity can reference a ConfigurationContext element to indicate that the Effectivity is only applicable to that ConfigurationContext. Attributes: configId: Unique identifier. name: Descriptive name Effectivity Base class. contextRef: the Product, ProductRevision, or ConfigurationContext in which this Effectivity applies. If absent, then the Effectivity is relevant for all Products and ProductRevisions which use the element to which the Effectivity is attached. Date Effectivity. Indicates that an element is effective between two specified dates. If the start date or end date is omitted, the effectivity is open-ended in that direction. Attributes: start: Start date and time. end: End date and time. Lot Effectivity. Indicates that an element is effective only for a certain 'lot' or batch. If the start date or end date is omitted, the effectivity is open-ended in that direction. Attributes: lot: Lot identifier. Serial Number Effectivity. Indicates that an element is effective for a range of serial numbers. If the start or end is omitted, the effectivity is open-ended in that direction. Attributes: start: Start serial number. end: End serial number. Option. This element specifies the valid values for an Option, either as a set of allowed values (i.e. an enum), or as a range of values of a particular type. Attributes: name: Option name. scope: Option scope. type: Option type - enum, string, int, real or logical. SubElements: Value: If the Option is of type enum, it should contain a sequence of Value sub-elements giving the allowed values. GreaterThan: ) If the Option type is not enum, then its allowed values are GreaterThanOrEqual: ) given by a range, which is specified by a GreaterThan or LessThan: ) GreaterThanOrEqual element, followed by a LessThan or LessThanOrEqual: ) LessThanOrEqual element. These are all of type OptionValueType. Default: Following these elements there may be a Default element giving a default value for the Option. Operand - abstract base class for Operands (arguments of operators). Statement - abstract base class for statements. StatementList - a list of statements. SubElements: Contains a non-empty sequence of elements derived from Statement. Expression - abstract base class for Expressions. LogicalExpression - abstract base class for expressions returning a logical result. And - a type of logical expression. SubElements: At least two sub-elements, derived from LogicalExpression. The And expression returns true if all its sub-elements return true. Or - a type of logical expression. SubElements: At least two sub-elements, derived from LogicalExpression. The Or expression returns true if any of its sub-elements return true. Not - a type of logical expression. SubElements: One sub-element, derived from LogicalExpression. The Not expression returns true if its sub-element returns false. OptionIs - a logical expression which returns true if a given Option has a particular relation to a given value (default equality relation). Attributes: optionRef: Reference to the Option. value: Specified value for the Option. operation: The operation. For example if operation is "gt", then OptionIs returns true if the option is greater than 'value'. Set. A Statement which sets an Option to a particular value. Attributes: optionRef: Reference to the Option. value: Specified value for the Option. SetDefault. A Statement which sets an Option to a particular value, if it is unset. Unlike the Set Statement, it will not override an existing value. Attributes: optionRef: Reference to the Option. value: Specified value for the Option. Fix. A Statement which sets an Option to a particular value, and fixes it. Subsequent Set, SetDefault, or Fix Statements are not allowed to modify it. Attributes: optionRef: Reference to the Option. value: Specified value for the Option. Message - abstract base class for Message Statements. Check Message. This is used in VariantRuleChecks. Attributes: message: String message to output. Inform Message. Outputs an informative message. Attributes: message: String message to output. Warn Message. Outputs a warning message. Attributes: message: String message to output. Error Message. Outputs an error message. Attributes: message: String message to output. ConditionalStatement. This is an If ... Then ... Else ... Statement. SubElements: First, an element derived from LogicalExpression. Then: StatementList element, executed if the LogicalExpression returns true. Else: Optional StatementList element, executed if the LogicalExpression returns false. VariantRule. This specifies a configuration by giving specified values for a set of Options. Attributes: name: Descriptive name configuredRef: The StructureRevision this VariantRule is associated with, if any. SubElements: A non-empty sequence of Set Statements, which specify values for a set of Options. VariantRuleCheck. This outputs a Check Message if a condition is true. SubElements: An element derived from LogicalExpression. A Check element. VariantDefault. An abstract base class for Variant Defaults. VariantDefaultFixed. This is a collection of 'SetDefault' Statements. SubElements: A non-empty sequence of SetDefault Statements, which set the values of some Options, if they are not already set. VariantDefaultDerived. A set of SetDefault Statements which depend on a LogicalExpression. SubElements: An element derived from LogicalExpression. A non-empty sequence of SetDefault Statements, which are executed if the expression returns true. VariantCondition. This contains a logical expression which determines whether the Instance it is attached to is 'loaded', i.e. appears in the configuration. SubElements: A single element derived from LogicalExpression. Component of a unit of measurement Attributes: exponent: power to which unit is raised, e.g. seconds**2 Unit - a unit of measurement, e.g. kilogram/metre**2 Based on the SI system, this specifies exponents for each of the 7 fundamental units. SubElements: Metre: a UnitComponent element giving the length exponent. ...etc... Base class for entities which can 'own' objects (people, organisations, users, sites, etc). An individual Person. Attributes: firstName: first name. middleNames: middle names and/or initials. lastName: last (family) name. userId: user Id. addressRef: optional reference to an Address element. A User, i.e. a user account on a computer system. Attributes: userId: User Id. personRef: optional reference to a Person element. An organisation, i.e. a group of people or users. Organisations are hierarchical. People/Users are associated with organisations by means of an OrganisationMember element, which also specifies a Role. Attributes: name: Name of Organisation. address: Optional reference to Address. organisationRefs: Reference to sub-organisations. A Role, e.g. "Designer", "Test Engineer", "Chairman", which a Person plays in an organisation. Attributes: name: The name of the role, i.e. "Designer". This element is used to associate a Person/User with an Organisation, and to assign an optional Role to that Person/User within that Organisation. A person may have more than one Role in an Organisation. Attributes: memberRef: Reference to a Person or User. organisationRef: The Organisation. roleRef: The Role. This is a class of people/users within an organisation, e.g. all people in Company A with role 'programmer'. As such it references an organisation and a role. It can be used as a resource without specifying a particular person. Attributes: organisationRef: The Organisation. roleRef: The Role. An address for a Person or Organisation. Attributes: internalLocation: Room, mailbox, etc. streetNumber: street: Name of street, road, lane, etc. town: Village, Town, City, etc. region: Region, County, State, etc. country: Country. postalCode: PostCode, ZIP, etc. emailAddress: telephone: A Site in the sense of a particular software installation, database, or location. Attributes: name Name of the Site siteId Identifying Id of the Site addressRef Optional reference to Address element. Simple Access Control enum. reference: read-only modifiable: read-write noAccess: may not be accessed at all. Simple access control element. Specifies a set of owners, and read/write access. Attributes: intent: reference, modifiable or noAccess. ownerRefs Reference to one or more owners. These should be elements derived from plm:OwnerBase, e.g. Person, Organisation, Site, etc. Simple status information. Attributes: dateCreated: Date and time created. dateModified: Date and time last modified. lastModifiedBy: Person or User who last modified this element. Checkout information. Attributes: by: Person etc. holding the checkout. Derived from OwnerBase. date: Date and time checked out. Attribute used to associate a DataSet with a PLM XML element. Attributes: dataSetRef: uri reference to DataSet role: role/purpose of DataSet. No specified values. Represents an external file. Attributes: locationRef: uri of the file format: format of the file. This should determine which applications can read the file. There is no fixed set of values for this, but will often correspond to the file extension, e.g. "doc", "txt". If the format is the same as a Representation format, e.g. "JT", then the same format string should be used. Represents a DataSet (collection of files) Attributes: name: name of the DataSet. version: version number. type: type of DataSet. No specified values. memberRefs: uri references to the members of the DataSet. These should be plm:ExternalFile elements. releaseStatusRefs: Reference to one or more ReleaseStatus elements, which give release dates and effectivities. ReleaseStatus. Specifies date of release, and effectivities. Attributes: name: Descriptive name. dateReleased: Date and time released. effectivityRefs: Reference to Effectivity elements.