RosettaNet XML Message Guidelines
ServiceHeader_MG_V02_00_01.htm (10-Apr-2001)

This document has been prepared by RosettaNet (http://www.rosettanet.org) from requirements

gathered during the cluster/segment workshops and in conformance with the RosettaNet methodology

 

1

1

ServiceHeader

2

1

       |-- ProcessControl

3

1

       |     |-- ActivityControl

4

1

       |     |     |-- BusinessActivityIdentifier

5

1

       |     |     |-- MessageControl

6

1

       |     |     |     |-- fromRole.GlobalPartnerRoleClassificationCode

7

1

       |     |     |     |-- fromService.GlobalBusinessServiceCode

8

0..1

       |     |     |     |-- inReplyTo.ActionControl

9

1

       |     |     |     |     |-- ActionIdentity

10

1

       |     |     |     |     |     |-- GlobalBusinessActionCode

11

0..1

       |     |     |     |     |     |-- messageStandard.FreeFormText

12

0..1

       |     |     |     |     |     |-- standardVersion.VersionIdentifier

13

1

       |     |     |     |     |-- messageTrackingID.InstanceIdentifier

14

1

       |     |     |     |-- Manifest

15

0..n

       |     |     |     |     |-- Attachment

16

0..1

       |     |     |     |     |     |-- description.FreeFormText

17

1

       |     |     |     |     |     |-- GlobalMimeTypeQualifierCode

18

1

       |     |     |     |     |     |-- UniversalResourceIdentifier

19

1

       |     |     |     |     |-- numberOfAttachments.CountableAmount

20

1

       |     |     |     |     |-- ServiceContentControl

21

1

       |     |     |     |     |     |-- Choice

22

 

       |     |     |     |     |     |     |-- ActionIdentity

23

1

       |     |     |     |     |     |     |     |-- GlobalBusinessActionCode

24

0..1

       |     |     |     |     |     |     |     |-- messageStandard.FreeFormText

25

0..1

       |     |     |     |     |     |     |     |-- standardVersion.VersionIdentifier

26

1

       |     |     |     |     |     |     |-- SignalIdentity

27

1

       |     |     |     |     |     |     |     |-- GlobalBusinessSignalCode

28

1

       |     |     |     |     |     |     |     |-- VersionIdentifier

29

1

       |     |     |     |-- toRole.GlobalPartnerRoleClassificationCode

30

1

       |     |     |     |-- toService.GlobalBusinessServiceCode

31

1

       |     |-- GlobalUsageCode

32

0..1

       |     |-- partnerDefinedPIPPayloadBindingId.ProprietaryReferenceIdentifier

33

1

       |     |-- pipCode.GlobalProcessIndicatorCode

34

1

       |     |-- pipInstanceId.InstanceIdentifier

35

1

       |     |-- pipVersion.VersionIdentifier

36

0..1

       |     |-- QualityOfServiceSpecification

37

1..n

       |     |     |-- QualityOfServiceElement

38

1

       |     |     |     |-- QualityOfServiceClassificationCode

39

1

       |     |     |     |-- Value

40

1

       |     |-- Choice

41

 

       |     |     |-- KnownInitiatingPartner

42

1

       |     |     |     |-- PartnerIdentification

43

0..1

       |     |     |     |     |-- domain.FreeFormText

44

1

       |     |     |     |     |-- GlobalBusinessIdentifier

45

0..1

       |     |     |     |     |-- locationID.Value

46

 

       |     |     |-- UnknownInitiatingPartner

47

1

       |     |     |     |-- PartnerIdentification

48

0..1

       |     |     |     |     |-- domain.FreeFormText

49

1

       |     |     |     |     |-- GlobalBusinessIdentifier

50

0..1

       |     |     |     |     |-- locationID.Value

51

1

       |     |     |     |-- UniformResourceLocator

 


Guideline Information

4: BusinessActivityIdentifier

Constraint: Special Validation and Processing Rules: For the valid value for this element, refer to the corresponding "Activity" element in the PIP Specification corresponding to the currently executing PIP and Activity. In its absence, the value is to be taken from the 'Activity Name' column of the PIP specification's 'Business Activity Descriptions' table.

 

5: MessageControl

User Notes: Note that all elements other than those in this group are set by the initiator and MUST remain the same through all messages in that PIP instance.

 

6: fromRole.GlobalPartnerRoleClassificationCode

Constraint: Special Validation and Processing Rules: For the valid value for this element, refer to the corresponding "FromRole" element (or "ToRole" element, as the case may be) in the PIP Specification corresponding to the currently executing PIP, Activity and Action. In its absence, the value is to be taken from the 'Role Name' column of the PIP specification's 'Partner Role Descriptions' table.

Constraint: If the current message is a signal, then the value corresponding to the "FromRole" in the signal must be the same as the value of the "ToRole" in the action to which this signal is replying.

 

7: fromService.GlobalBusinessServiceCode

Constraint: Special Validation and Processing Rules: For the valid value for this element, refer to the corresponding "FromService" element (or "ToService" element, as the case may be) in the PIP Specification corresponding to the currently executing PIP, Activity and Action. In its absence, the value is to be taken from the 'Network Component in FSV' column of the PIP specification's 'Network Component Specification' table.

Constraint: If the current message is a signal, then the value corresponding to the "FromService" in the signal must be the same as the value of the "ToService" in the action to which this signal is replying.

 

8: inReplyTo.ActionControl

User Notes: MUST be present if this is not the first message in an activity. MUST be present for all signals.

 

10: GlobalBusinessActionCode

User Notes: For the valid value for this element, refer to the corresponding "inReplyTo.ActionControl" element in the PIP specification corresponding to the currently executing PIP, Activity and Action. In its absence, the value is to be taken from the 'Business Action in FSV' column of the PIP specification's 'Business Action - Business Document Mapping' table.

 

11: messageStandard.FreeFormText

User Notes: Must be present if non-RosettaNet-defined service content is carried. Must not be present for RosettaNet-defined service content. Value to be established by partners in the Trading Partner Agreement.

 

12: standardVersion.VersionIdentifier

User Notes: Must be present if non-RosettaNet-defined service content is carried. Must not be present for RosettaNet-defined service content. Value to be established by partners in the Trading Partner Agreement.

 

17: GlobalMimeTypeQualifierCode

User Notes: This value must be chosen from the MIME content type for the attachment. A list of possible values may be found in the Media Types Directory, maintained by the Internet Assigned Numbers Authority (http://www.iana.org/).

 

18: UniversalResourceIdentifier

User Notes: This value MUST follow the content-ID reference syntax per RFC 2111 and MUST refer to the MIME content-ID of the attachment.

 

19: numberOfAttachments.CountableAmount

User Notes: If no attachments, the only allowed value is '0' (i.e., the number zero).

 

23: GlobalBusinessActionCode

User Notes: For the valid value for this element, refer to the corresponding "inReplyTo.ActionControl" element in the PIP specification corresponding to the currently executing PIP, Activity and Action. In its absence, the value is to be taken from the 'Business Action in FSV' column of the PIP specification's 'Business Action - Business Document Mapping' table.

 

24: messageStandard.FreeFormText

User Notes: A value must be specified only for non-RosettaNet entities.

 

25: standardVersion.VersionIdentifier

User Notes: A value must be specified only for non-RosettaNet entities.

 

27: GlobalBusinessSignalCode

Entity Instances
Receipt Acknowledgment: Acknowledge receipt of business message
Exception: Processing exception response.

 

28: VersionIdentifier

Constraint: Special Validation and Processing Rules: The value for this element MUST be obtained from the Signal Version Identifier field of the identified Business Signal's Message Guideline.

 

29: toRole.GlobalPartnerRoleClassificationCode

Constraint: Special Validation and Processing Rules: For the valid value for this element, refer to the corresponding "FromRole" element (or "ToRole" element, as the case may be) in the PIP Specification corresponding to the currently executing PIP, Activity and Action. In its absence, the value is to be taken from the 'Role Name' column of the PIP specification's 'Partner Role Descriptions' table.

Constraint: If the current message is a signal, then the value corresponding to the "FromRole" in the signal must be the same as the value of the "ToRole" in the action to which this signal is replying.

 

30: toService.GlobalBusinessServiceCode

Constraint: Special Validation and Processing Rules: For the valid value for this element, refer to the corresponding "FromService" element (or "ToService" element, as the case may be) in the PIP Specification corresponding to the currently executing PIP, Activity and Action. In its absence, the value is to be taken from the 'Network Component in FSV' column of the PIP specification's 'Network Component Specification' table.

Constraint: If the current message is a signal, then the value corresponding to the "FromService" in the signal must be the same as the value of the "ToService" in the action to which this signal is replying.

 

31: GlobalUsageCode

Entity Instances
Test: This is a test message.
Production: This is a production message.

 

32: partnerDefinedPIPPayloadBindingId.ProprietaryReferenceIdentifier

User Notes: Value to be established by partners in the Trading Partner Agreement. Must be present if non-RosettaNet-defined content is carried; must not be present if RosettaNet-defined content is used.

 

33: pipCode.GlobalProcessIndicatorCode

User Notes: Alphanumeric designation code of the PIP that is being executed (e.g. '3A4').

 

34: pipInstanceId.InstanceIdentifier

User Notes: MUST be unique within the context of the initiating partner.

 

35: pipVersion.VersionIdentifier

Constraint: Special Validation and Processing Rules: The valid value for this element MUST be obtained from the PIP Version Identifier element in the PIP Specification corresponding to the currently executing PIP.

 

38: QualityOfServiceClassificationCode

Entity Instances

 

39: Value

User Notes: Valid values are defined within the context of the QualityOfServiceClassificationCode.

 

51: UniformResourceLocator

User Notes: MUST be specified or further processing may not be possible.

 


Business Properties

Name

Definition

fromRole

The role initiating a business document exchange.

fromService

The business service from which a message is being sent.

inReplyTo

The business action that this message is replying to.

messageStandard

The model of authority used to create the message.

standardVersion

The version of the message standard used to create the message.

messageTrackingID

Uniquely identifies message for tracking purposes. This value comes from the Message Tracking ID in the Delivery Header of the original received message that is being replied to.

description

A description of a process, thing, action, etc.

numberOfAttachments

Number of attachments included as part of a message.

toRole

The role receiving the document in a business document exchange.

toService

The business service to which a message is being sent.

partnerDefinedPIPPayloadBindingId

Agreed-upon ID indicating type of payload included as part of this message.

pipCode

GlobalProcessIndicatorCode indicates the standard business process with which this message is associated.

pipInstanceId

Identifier for this message instance, relates to GlobalProcessIndicatorCode.

pipVersion

Indicates version of standard that is applicable. This property qualifies 'pipCode'.

domain

DUNS.

locationID

Identifies a logical business location associated with a trading partner.

 


Business Data Entities

Name

Definition

ServiceHeader

Processing control properties for RosettaNet Business Service messages.

ProcessControl

The collection of business properties that describe business process message control.

ActivityControl

The collection of business properties that describe control of a specific activity.

MessageControl

The collection of business properties specific to each message (within a transaction.)

ActionControl

Business action message control properties.

ActionIdentity

The collection of business properties that identify a business action.

Manifest

Specifies ServiceContent, along with number of, and list of items included in message.

Attachment

A business property that describes additional information regarding a product or process.

ServiceContentControl

Group of properties relating to message standard and version being used, and type of message (Action or Signal).

SignalIdentity

The collection of business properties that are used to identify a business signal.

QualityOfServiceSpecification

The collection of business properties that specifies quality of service constraints for this message instance.

QualityOfServiceElement

The collection of business properties that specifies a quality of service constraint item.

KnownInitiatingPartner

GlobalBusinessIdentifier of the partner initiating the business process. TPA has been established for this party.

PartnerIdentification

The collection of business properties used to identify a business partner.

UnknownInitiatingPartner

GlobalBusinessIdentifier of the partner initiating the business process. TPA has not been established for this party.

 


Fundamental Business Data Entities

Name

Definition

Data Type

Min

Max

Representation

BusinessActivityIdentifier

An identifier which specifies a business activity. This code is found in table 3.2 in a PIP specification document.

String

1

255

 

GlobalPartnerRoleClassificationCode

Code identifying a party's role in the supply chain. This code is found in table 3.1 in a PIP specification document.

String

1

255

 

GlobalBusinessServiceCode

Code identifying a business service network component. This code is found in table 4.1 in a PIP specification document.

String

1

255

 

GlobalBusinessActionCode

Code identifying a business action. The identifier is found in table 4.2 of the PIP specification document.

String

1

255

 

FreeFormText

Unformatted text.

String

1

 

 

VersionIdentifier

A unique identifier specifying the version of an entity e.g. a product, a message format, or a standard.

String

1

255

 

InstanceIdentifier

A unique alpha-numeric identifier that represents a specific instance of an business process, business transaction, business action or business signal. The instance identifier must be unique for a particular instance of a business process, business transaction, business action and business signal.

String

1

255

 

GlobalMimeTypeQualifierCode

The MIME type. Refer to http://www.iana.org for a list of types.

String

1

 

 

UniversalResourceIdentifier

A network-centric identifier that provides the identity of a resource.

String

1

 

 

CountableAmount

Dimensionless magnitude, e.g. number of products.

NaturalNumber

1

15

9(15)

GlobalBusinessSignalCode

Code identifying the business signal message.

String

1

255

 

GlobalUsageCode

Code identifying the message use specification is either for production or for testing.

String

4

10

 

ProprietaryReferenceIdentifier

A unique reference identifier for goods, services or business documents.

String

1

255

 

GlobalProcessIndicatorCode

Code identifying the business process.

String

1

255

 

QualityOfServiceClassificationCode

Identifies the quality of service measurement category.

String

1

 

 

Value

The value for a property e.g. a technical specification.

String

1

255

 

GlobalBusinessIdentifier

A unique business identifier. The DUNS number is specified by RosettaNet.

Integer

9

9

9(9)

UniformResourceLocator

A network address location for a network resource.

String

8