RosettaNet XML Message Guidelines
2A9_MG_V01_00_00_ECTechnicalInformationQuery.htm (11-Apr-2001 12:00)

This document has been prepared by Si2, Inc. (http://www.si2.org)

in conformance with the RosettaNet methodology.

1

0..1

qd.key

2

1

dicIdentifier.FPI

3

1

Query

4

0..1

      |-- startingAt

5

0..1

      |-- maxRecords

6

0..n

      |-- Element

7

0..1

      |      |-- id

8

0..1

      |      |-- dicRef

9

1

      |      |-- Name

10

0..n

      |      |-- Value

11

0..1

      |      |      |-- valueType

12

0..1

      |      |      |-- ntolAbs.toleranceAbs

13

0..1

      |      |      |-- ntolPer.tolerancePer

14

0..1

      |      |      |-- ptolAbs.toleranceAbs

15

0..1

      |      |      |-- ptolPer.tolerancePer

16

0..1

      |      |      |-- MatchCriteria

17

0..n

      |-- CharacteristicSet

18

0..1

      |      |-- id

19

0..1

      |      |-- dicRef

20

0..1

      |      |-- members

21

1

      |      |-- Name

22

0..n

      |-- DataObjectRequest

23

1

      |      |-- ObjectId

24

1

fromRole.PartnerRoleDescription

25

1

      |-- ContactInformation

26

1

      |      |-- contactName

27

1

      |      |-- telephoneNumber.CommunicationsNumber

28

1

      |      |-- EmailAddress

29

1

      |-- GlobalPartnerRoleClassificationCode

30

1

      |-- PartnerDescription

31

1

      |      |-- GlobalPartnerClassificationCode

32

1

      |      |-- BusinessDescription

33

1

      |      |      |-- GlobalBusinessIdentifier

34

1

      |      |      |-- GlobalSupplyChainCode

35

1

toRole.PartnerRoleDescription

36

1

      |-- GlobalPartnerRoleClassificationCode

37

1

      |-- PartnerDescription

38

1

      |      |-- GlobalPartnerClassificationCode

39

1

      |      |-- BusinessDescription

40

1

      |      |      |-- GlobalBusinessIdentifier

41

1

      |      |      |-- GlobalSupplyChainCode

42

1

thisDocumentGenerationDateTime.DateTimeStamp

43

1

thisDocumentIdentifier.ProprietaryDocumentIdentifier

44

1

GlobalDocumentFunctionCode


Business Properties

Name

Definition

fromRole

All semantics conform to RosettaNet conventions and are specified in the Business Dictionary.

contactName

All semantics conform to RosettaNet conventions and are specified in the Business Dictionary.

telephoneNumber

All semantics conform to RosettaNet conventions and are specified in the Business Dictionary.

toRole

All semantics conform to RosettaNet conventions and are specified in the Business Dictionary.

thisDocumentGenerationDateTime

All semantics conform to RosettaNet conventions and are specified in the Business Dictionary.

thisDocumentIdentifier

All semantics conform to RosettaNet conventions and are specified in the Business Dictionary.

GlobalDocumentFunctionCode

All semantics conform to RosettaNet conventions and are specified in the Business Dictionary.


Business Data Entities

Name

Definition

qd.key

An arbitrary identifier.
  1. If 'qd.key' is specified in a Query then the same value shall be specified in the Response.

dicIdentifier

The unique identifier of the dictionary instance to which are compliant the semantics of all elements in the contents of the containing Query or Response that do not reference definitions in the local ECDictionaryAdd.
  1. This value shall match the formal public identifier (FPI) of an instance of the Electronic Components Technical Dictionary (ECTD).

Query

A request for product information, the content of which consists of zero or more request specifications, each of which identifies the information to be returned in a response for each product. Each request specification may be one of: Element, CharacteristicSet,or DataObjectRequest.
  1. If the request specification is:
     a) Element: then the request is for the value of that element.
     b) CharacteristicSet: then the request is for the values for each Element referenced therein, recursively for each CharacteristicSet referenced therein.
     c) DataObjectRequest: then the request is for the actual object.
  2. The presence of a Value in a request specification defines a match criteria specification for only products with information matching all indicated criteria (ie, the intersection of products matching each individual criteria specification).
  3. The XML instance containing this object shall be preceded by a "DOCTYPE" statement with a "PUBLIC" keyword and associated formal public identifier (FPI) that identifes the exact version of the DTD being used. A "SYSTEM" identifier shall follow the FPI.

Element

The association of a product information characteristic Name with a Value.
  1. An ProductInformationDistributor may include any Element in a Response regardless of whether it was included as a request specification in a Query.
In a Query:
  2. There shall not be two Elements with the same Name content.
In a Response:
  3. If two Elements have the same Name content, then both values shall apply to the parent PartInfo.

Name

The name of a Characteristic, or CharacteristicSet related to a product.
  1. If dicRef is specified in the containing Element then the Name content shall match the preferred.name of the dictionary entry identified by the dicRef.
  2 If the Name matches the preferred.name of an entry in the dictionary named by the dicIdentifier, the semantics of the parent Element shall conform to that dictionary entry.
In a Query:
  3. The content may be anything.
In a Response:
  4. In the case where a Name from the Query does not match the preferred.name of an entry in the dictionary named by the dicIdentifier then the InformationDistributor shall respond with a Characteristic that has the Name from the Query and whose Value is one of:
     (a) null, and a NoValueReason="not.in.dictionary".
     (b) non-null, with a dicRef that references a CharacteristicDefinition in the ECDictionaryAdd.
  5. In the case where the Name does not match the preferred.name of an entry in the dictionary named by the dicIdentifier, or dicRef does not reference an entry in that dictionary, then the Name shall match the preferred.name of an appropriate entry in the ECDictionaryAdd, and the dicRef shall reference that entry.

Value

The value associated with the containing Element.
  1. If the defining dictionary entry has a Unit, then the Value shall be a measurement in the unit so defined.
  2. In any Element there shall be at most one Value element with a 'type' attribute of a given value.
  3. In any Element there shall be at most one Value element with no 'type' attribute.
  4. If an Element contains a Value element with a 'type' attribute then that Element shall not also contain a Value element with no 'type' attribute.
In a Response:
  5. Every Element shall contain at least one Value.
  6. In a Response the content shall conform to the encoding constraints specified by the value.format of the corresponding dictionary entry.
In a Query:
  7. The content is a MatchCriteria.

valueType

A qualifier describing the kind of measurement a Value represents.
  1. If present, the value of the valueType object shall match exactly the content of the preferred.name element of a ValueType entry in the ECTD referenced by the dicIdentifier of the current instance, and the semantics of that ValueType entry shall apply to the content of the current Value.
  2. If absent, the content of the current Value may be interpreted by either sender or receiver of the information as any value within the domain of values that conforms to the semantics of the corresponding dictionary entry.
  3. None of the attributes 'ptol.abs', 'ptol.per', 'ntol.abs', 'ntol.per' shall be specified if the value of the valueType is not "nom".

ntolAbs

A negative tolerance applicable for the current Value.

ptolAbs

A positive tolerance applicable for the current Value.

ntolPer

A negative tolerance applicable for the current Value.

ptolPer

A positive tolerance applicable for the current Value.

noValueReason

A qualifier specifying the reason for a null or empty Value content.
  1. If the Value content is non-null then the 'NoValueReason' attribute shall be null.
  2. The 'NoValueReason' attribute shall be null if a 'type' attribute is present.
  3. If the Value content is null then 'NoValueReason' shall match the preferred.name of a NoValueReason entry in the ECTD dictionary, and that entry's semantics shall document the reason why the Value content is null.
  4. 'NoValueReason' shall not be used in a Query.

notAvaliable

The Value is null because it is not available.

notApplicable

The Value is null because this Characteristic does not apply to the product.

notSupplied

The Value is null because the ProductInformationDistributor declines to supply it.

measured

The Value is null because it was actually measured as null.

MatchCriteria

An expression that specifies only those products with values for the corresponding Element should be returned in a Response.
  1. The match criteria specification syntax for the Value of any Element shall be defined by the content of the <app.specific> element (in the corresponding dictionary entry) that has a 'name' attribute with a value of "query.syntax".
  2. All matching is case insensitive. The table, "Criteria Match Specification Syntax" defines the detailed semantics for each match criteria specification syntax allowed.
  3. If no app.specific tag exists in the dictionary entry, the entire Value content is to be matched exactly, except for case.
  4. If the content of the app.specific tag is "ML", then the content shall be a blank-separated list of strings. A query shall match components whose values for the corresponding element match any one of the blank-separated strings in the list, but the values must match exactly (except for case). Strings to be matched that include blanks shall be surrounded in double quotes.
  5. If the content of the app.specific tag is "EX", then the content shall be one or more substrings to be matched, along with any of number of optional expression operators (where a substring consists of all characters between operators, and the & operator shall be represented as &):
 
    Operator      Description
 
            +         match includes both left and right substring
            &        match includes both left and right substring
            AND   match includes both left and right substring
 
            -          match does not include
            NOT   match does not include
 
             |          match includes either left or right substring
            or         match includes either left or right substring
            OR       match includes either left or right substring
 
            ( )        group boolean sub expressions
 
            " "       match must include the entire phrase bounded by the quotes exactly (except for case)
                       (other operators are treated as ordinary characters inside quotes)

CharacteristicSet

A set of Elements and/or other CharacteristicsSets related to a product.
In a response:
  1. A CharacteristicSet shall reference an Element for each CharacteristicDefinition in the corresponding PropertyDefinitionSet (in the ECTD referenced by the dicIdentifier), and in the ECTD defined order.
  2. Additional Elements may be reported at the end of the set of ECTD-defined ones, in any order.

DataObjectRequest

A request for a product information object.
  1. The content shall be the Distributor ObjectId for the PIO.
  2. If the content is null the request shall be for the TOC.

Response

Information for zero or more products that match the criteria specified in the corresponding query.
  1. The supplier shall decide what constitutes a match.
  2. If the 'matched' attribute is specified, it shall indicate the total number of products matching the match criteria of the corresponding query.
  3. If the 'startingAt' attribute is specified, it shall indicate that the set of PartInfo elements returned corresponds to an ordered set of products matching the match criteria, and shall define the ordinal position of the first PartInfo in that set (numbered from 1).
  4. If the 'returned' attribute is specified, it shall be the total number of PartInfo elements in the Response.
  5. A Response shall contain all requested Characteristics and CharacteristicSets, however, the value of any Characteristic may be null, in which case a NoValueReason shall be supplied.
  6. The InformationDistributor may include zero or more Characteristics of its choice in a Response, whether or not they were requested in the Query.
  7. The XML instance containing this object shall be preceded by a "DOCTYPE" statement with a "PUBLIC" keyword and associated formal public identifier (FPI) that identifes the exact version of the DTD being used. A "SYSTEM" identifier shall follow the FPI.

Status

An indicator confirming success or failure of the supplier's attempt to process the Query.
  1. If the content matches exactly the preferred name of a TermDefinition entry in the standard dictionary that also includes the tag: <app.specific name="status"></app.specific> with a content that matches the name of the tag that is the content for the Status element, then the semantics defined in that entry shall be presumed to apply.
  2. If the content of the Status is other than ECsuccess then no PartInfo elements shall be included in the Response.

ECsuccess

Product information matching the Query criteria is being returned in the <RESPONSE>.

ECfail

The supplier is unable to return a useful Response due to supplier-side system or communication problems.

ECbadQuery

The Query does not conform to all applicable specifications.

ECnoMatch

There is no product information matching the Query MatchCriteria.

ECnotAvailable

The information requested may or may not exist, however, the ProductInformationDistributor declines to return it.

ECrescheduleQuery

A time -- expressed in ISO 8601 format according to section 5.4.1. of ISO 8601 (YCCYYMMDDThhmmssZ) -- at which the same Query, if resent, would yield the data requested. (NOTE: This might be used if the Query would result in a large amount of data that would be more successfully transmitted by the Distributor at a later time.)

PartInfo

A container grouping information related to a product.
  1. The content shall relate to a single product.
  2. There shall not be two instances of a PartInfo for the same product in the same Response.
  4. If the criteria specified in the corresponding Query match any supplier products, the supplier shall return at least one PartInfo instance.
  5. The Response shall not include more PartInfo instances than the number specified by the maxRecords attribute of that Query.
  6. If the content of Status is not ECsuccess then no PartInfo elements shall be returned.
  7. The supplier shall determine what constitutes a suitable match.

PIO

Meta data describing a logical representation of a set of arbitrary data (whose semantics are defined in an ECTD entry) related to a product.

ObjectName

The Distributor name for the containing PIO.

Version

An arbitrary identifier indicating a content revision level.

Location

The URL for this PIO a request to which shall return only the PIO.

Reference

A URL related to this PIO.

Legal

A URL that defines terms, conditions, disclaimers, warnings, limitations, or other information related to the use of PIO.

ObjectId

An identifier for this PIO unique in the namespace of the ProductInformationDistributor.

Supplier

The DUNS of the creator of this PIO.

Description

Information that characterizes or otherwise identifies this PIO.

ModificationDate

The last time a change was made, expressed in ISO 8601 format (YYYYMMDD).

EffectiveDate

A date prior to which the information may not be valid, but after which it is valid, expressed in ISO 8601 format (YYYYMMDD).

ContentTypeRef

A unique identifier that defines the category of information provided by this PIO.
  1. The identifier shall match the preferred.name of a ContentType entry in the dictionary referenced by the dicIdentifier or an entry in the ECDictionaryAdd of the containing instance.

FileFormatRef

A unique identifier that defines the type data encoding for this PIO.
  1. The identifier shall match the preferred.name of a FileFormat entry in the dictionary referenced by the dicIdentifier or an entry in the ECDictionaryAdd of the containing instance.

TargetSoftware

An identifier for a tool that can be used to process this PIO.

ECDictionaryAdd

A container for dictionary information referenced by the Response but not contained in the standard ECTD.

Class

All semantics are specified in the EC Technical Dictionary Specification.

CharacteristicDefinition

All semantics are specified in the EC Technical Dictionary Specification.

PropertyDefinitionSet

All semantics are specified in the EC Technical Dictionary Specification.

TermDefinition

All semantics are specified in the EC Technical Dictionary Specification.

ContentType

All semantics are specified in the EC Technical Dictionary Specification.

FileFormat

All semantics are specified in the EC Technical Dictionary Specification.

ValueCodes

One or more enumerated values to be added to an existing value code list.
  1. The value of the 'dicRef' attribute shall match the value of an 'id' attribute of a CharacteristicDefinition entry in the standard ECTD, and each child DicValue shall be considered to be part of the ValueDomain of that entry.

DicValue

All semantics are specified in the EC Technical Dictionary Specification.

PartnerRoleDescription

All semantics conform to RosettaNet conventions and are specified in the Business Dictionary.

ContactInformation

All semantics conform to RosettaNet conventions and are specified in the Business Dictionary.

PartnerDescription

All semantics conform to RosettaNet conventions and are specified in the Business Dictionary.

BusinessDescription

All semantics conform to RosettaNet conventions and are specified in the Business Dictionary.


Fundamental Business Data Entities

Name

Definition

Data Type

Min

Max

Representation

FPI

A formal public identifier as defined in ISO/IEC 9070:1991.

String

1

255

X(255)

startingAt

The ordinal position of the first product in the ordered set of all products matching the match criteria specifications of a Query, independent of how many are actually returned in a Response.
  1. This value shall not exceed the value of the 'matched' attribute, if any.
  2. If specified in a Query then one of the following shall be true of the corresponding Response:
     (a) The Status content shall be ECnotAvailable with the content "starting.at.not.supported", in the case that product data would have been returned had 'starting.at' not been included in the query.
     (b) The value of the 'starting.at' attribute shall match the value of the 'starting.at' attribute in the Query, unless that value exceeds the number of parts matched, in which case it shall be 0. A 'starting.at' attribute greater than 0, shall indicate that the global set of all products matching the search criteria is an ordered set invariant (to the extent a Distributor chooses) across all queries; and that the PartInfo elements returned is an ordered subset of that global set, and that the 'starting.at' value defines the ordinal position of the first PartInfo in the global set (numbered from 1). The Distributor shall not be obligated to guarantee that the global matching set of products remains invariant under changes to its repository.

Integer

1

9

9(9)

maxRecords

A limit on the number of records that should be returned in a Response>.
  1. If specified the value shall be a positive integer.
  2. If specified the number of PartInfo elements in the corresponding Response shall not exceed the value of maxRecords.

Integer

1

9

9(9)

id

A unique XML identifier that may be the target of an IDREF reference from another element.
  1. The first 10 characters of an 'id' attribute that occurs within a ECDictionaryAdd shall be the character "x" followed by the nine digits of the DUNS number of the supplier.

ID

1

32

X(32)

dicRef

A reference to a dictionary entry.
  1. If used, the value of the 'dicRef' attribute shall consist of a "code part", followed by the "-" character, followed by a "majRev part".
    a) The "majRev part" shall match the content of the majRev of an entry in either the dictionary identified by the dicIdentifier or the ECDictionaryAdd content in the current instance.
    b) The " code part" shall match the content of the code of an entry in either the dictionary identified by the dicIdentifier or the ECDictionaryAdd content in the current instance.
  2. The entry referenced by 'dicRef' shall be a:
    a) CharacteristicDefinition if 'dicRef' is an attribute of Element.
    b) PropertyDefinitionSet if 'dicRef' is an attribute of CharacteristicSet.
    c) CharacteristicDefinition if 'dicRef' is an attribute of ValueCodes.
  3. Use of a "dicRef" shall constitute assurance that the element conforms to all semantics of the definition.short and definition.ext of the dictionary entry referenced, in addition to other entry semantics defined elsewhere in this specification.
  4. A dicRef shall be mandatory if the Element, CharacteristicSet, ContentType, or FileFormat is defined in the ECDictionaryAdd of the current instance.
  5. In the case where an Element or CharacteristicSet in a Query does not have a 'dicRef' attribute:
     a. If there exists an entry in the standard dictionary version (referenced by the dicIdentifier content in the Response) whose preferred.name content matches the Name content, if then the corresponding object in the Response shall conform to the semantics of that dictionary entry.
     b. If no matching preferred.name exists in the standard dictionary version (referenced by the dicIdentifier content in the Response), then an object with the same Name content as that in the Query shall be included in the Response, and exactly one of the following is true:
        i. The value of the 'dicRef' attribute of that object shall match the value of an 'id' attribute of an entry in the ECDictionaryAdd.
        ii. The content of the child Value of that object shall be empty and shall include a 'NoValueReason' attrbute with a value of "not.in.dictionary".
  6. In the case where an object in a Query has a 'dicRef' attribute, and the corresponding object in the response also has a 'dicRef' attribute, then:
     a. If there exists an entry in the dictionary (referenced by the dicIdentifier content in the Response) with a code object whose content matches the "code" part of the 'dicRef' value, and a majRev object whose content matches the "majRev" part of that value, then that same 'dicRef' value shall be used in the object in the Response.
     b. If exists an entry in that dictionary with a matching code but different majRev, then a 'dicRef' value with the matching code but different majRev shall be used in the object in the Response.

String

1

32

X(32)

returned

The total number of PartInfo instances in the current Response.
  1. This value shall not exceed the value of the 'matched' entity, if any.

Integer

1

9

9(9)

matched

If specified, the number of products matching the criteria specifications in the Query corresponding to the current Response.

Integer

1

9

9(9)

toleranceAbs

The tolerance expressed as a non-negative real number to be added or subtracted from the current Value.

Real

1

15

9(15)

tolerancePer

The tolerance expressed as a non-negative percent of the current Value.

Integer

1

15

9(15)

members

The ordered set of references to the Elements and/or CharacteristicSets in the current instance that are members of the current CharacteristicSet.
  1. Each value shall match the value of the 'id' attribute of either an Element or CharacteristicSet.
In a query:
  2. Any Characteristics that appear shall be in the same relative order as the CharacteristicDefinitions referenced by the 'propDefs' attribute of the corresponding PropertySetDefinition entry.
In a response:
  3. The order of the Characteristics referenced shall match the order of the CharacteristicDefinitions referenced by the propDefs of the corresponding PropertySetDefinition entry.
  4. There shall be a reference to a Characteristic for each CharacteristicDefinition in the corresponding PropertySetDefinition entry.
  5. No Elements or CharacteristicSets shall be referenced outside of the parent PartInfo.

IDREFS

1

4096

X(4096)

href

A reference to the Content-Id attribute of a MIME attachment specified as "cid:MIME_content-id_of_attachment" in accordance with RFC 2111 (http://rfc.fh-koeln.de/rfc/html/rfc2111.html).
  1. If the value of href is null (i.e., "") then noValueReason shall match the preferred.name of a NoValueReason entry in the ECTD dictionary, and that entry's semantics shall document the reason why the PIO is not attached.
  2. If the value of href is non-null then noValueReason shall not be used.

ID

1

128

X(128)

URL

A Uniform Resource Locator defined in accordance with RFC 2396 (http://www.w3.org/Addressing).

ID

1

512

X(512)

FreeFormText

All semantics conform to RosettaNet conventions and are specified in the Business Dictionary.

CommunicationsNumber

All semantics conform to RosettaNet conventions and are specified in the Business Dictionary.

EmailAddress

All semantics conform to RosettaNet conventions and are specified in the Business Dictionary.

GlobalPartnerRoleClassificationCode

All semantics conform to RosettaNet conventions and are specified in the Business Dictionary.

GlobalPartnerClassificationCode

All semantics conform to RosettaNet conventions and are specified in the Business Dictionary.

GlobalBusinessIdentifier

All semantics conform to RosettaNet conventions and are specified in the Business Dictionary.

GlobalSupplyChainCode

All semantics conform to RosettaNet conventions and are specified in the Business Dictionary.

DateTimeStamp

All semantics conform to RosettaNet conventions and are specified in the Business Dictionary.

ProprietaryDocumentIdentifier

All semantics conform to RosettaNet conventions and are specified in the Business Dictionary.

GlobalDocumentFunctionCode

All semantics conform to RosettaNet conventions and are specified in the Business Dictionary.


Quantitative Fundamental Business Data Entities

Name

Definition

Data Type

Min

Max

Representation

Dimension

FileSize

The size of an object.

Integer

1

12

9(12)

bytes



 

Created by Si2, Inc.