RosettaNet XML Message Guidelines
0A1_MG_V02_00_00_FailureNotification.htm (13-Jul-2001)

1

1
ActionControl

2

1
      |-- ActionIdentity

3

1
      |      |-- GlobalBusinessActionCode

4

0..1
      |      |-- messageStandard.FreeFormText

5

0..1
      |      |-- standardVersion.VersionIdentifier

6

1
      |-- messageTrackingID.InstanceIdentifier

7

0..1
failedInitiatingDocumentDateTime.DateTimeStamp

8

0..1
failedInitiatingDocumentIdentifier.ProprietaryDocumentIdentifier

9

1
fromRole.PartnerRoleDescription

10

1
      |-- ContactInformation

11

1
      |      |-- contactName.FreeFormText

12

1
      |      |-- EmailAddress

13

0..1
      |      |-- facsimileNumber.CommunicationsNumber

14

1
      |      |-- telephoneNumber.CommunicationsNumber

15

1
      |-- GlobalPartnerRoleClassificationCode

16

1
      |-- PartnerDescription

17

1
      |      |-- BusinessDescription

18

1
      |      |      |-- GlobalBusinessIdentifier

19

1
      |      |      |-- GlobalSupplyChainCode

20

1
      |      |-- GlobalPartnerClassificationCode

21

1
GlobalDocumentFunctionCode

22

1
ProcessIdentity

23

1
      |-- GlobalProcessIndicatorCode

24

1
      |-- InstanceIdentifier

25

1
      |-- VersionIdentifier

26

1
reason.FreeFormText

27

1
thisDocumentGenerationDateTime.DateTimeStamp

28

1
thisDocumentIdentifier.ProprietaryDocumentIdentifier

29

1
toRole.PartnerRoleDescription

30

0..1
      |-- ContactInformation

31

1
      |      |-- contactName.FreeFormText

32

1
      |      |-- EmailAddress

33

0..1
      |      |-- facsimileNumber.CommunicationsNumber

34

1
      |      |-- telephoneNumber.CommunicationsNumber

35

1
      |-- GlobalPartnerRoleClassificationCode

36

1
      |-- PartnerDescription

37

1
      |      |-- BusinessDescription

38

1
      |      |      |-- GlobalBusinessIdentifier

39

1
      |      |      |-- GlobalSupplyChainCode

40

1
      |      |-- GlobalPartnerClassificationCode

Guideline Information

2: ActionIdentity
User Notes: This action identity is the identity of the action that corresponds to the failed business activity's requesting business document. The content of this action identity entity must be the same as that in the original requesting business message's service header.

7: failedInitiatingDocumentDateTime.DateTimeStamp
User Notes: If RosettaNet-defined service content was used by the failed process, this element must be present, and its value must be taken from the thisDocumentGenerationDateTime.DateTimeStamp element of the service content of the failed process' initiating document. May be present if non-RosettaNet-defined service content was used, in which case the rule for populating this value is to be established by partners in the Trading Partner Agreement.

8: failedInitiatingDocumentIdentifier.ProprietaryDocumentIdentifier
User Notes: If RosettaNet-defined service content was used by the failed process, this element must be present, and its value must be taken from the thisDocumentIdentifier.ProprietaryDocumentIdentifier element of the service content of the failed process' initiating document. May be present if non-RosettaNet-defined service content was used, in which case the rule for populating this value is to be established by partners in the Trading Partner Agreement.

15: GlobalPartnerRoleClassificationCode
Constraint: Special Validation and Processing Rules: For the valid value for this element, refer to the 'Role Name' column of this PIP specification's 'Partner Role Descriptions' table.

21: GlobalDocumentFunctionCode
Entity Instances
Request: The business document is a request for a business action to be performed by a partner.

22: ProcessIdentity
User Notes: The failure notification document is sent if a business activity reaches the FAILURE state. This process identity is the identity of the process that was choreographing the failed business activity. The contents of this process identity entity must be the same as that in the original requesting business message's service header.

35: GlobalPartnerRoleClassificationCode
Constraint: Special Validation and Processing Rules: For the valid value for this element, refer to the 'Role Name' column of this PIP specification's 'Partner Role Descriptions' table.

39: GlobalSupplyChainCode
Entity Instances
Information Technology: The information technology supply chain.
Electronic Components: The electronic components supply chain.

40: GlobalPartnerClassificationCode
Entity Instances
Carrier: Product carrier for transporting goods in supply chain.
Distributor: Product distributor in supply chain.
End User: Product end user in supply chain.
End User Government: End user government.
Financier: Financial service provider in supply chain
Manufacturer: Product manufacturer in supply chain.
Retailer: Product retailer in supply chain.
Shopper: Product shopper in supply chain.
Freight Forwarder: Product freight forwarder for transporting goods in supply chain.
Broker: Representative of a third party.
Customs Broker: Product customs broker in supply chain.
Warehouser: Product warehouser in supply chain.
Distribution Center: Product distributor in supply chain.
Contract Manufacturer: The party responsible for the services rendered.
Reseller: A party buys goods from a manufacturer and resells them to customers unchanged.
Original Equipment Manufacturer: Product manufacturer of original equipment in the supply chain.

Business Properties

Name

Definition

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.

failedInitiatingDocumentDateTime
The date-time stamp indicating when the initiating document of the failed process was generated.

failedInitiatingDocumentIdentifier
Unique tracking identification of the failed process' initiating business document.

fromRole
The role initiating a business document exchange.

contactName
Name of the contact person(s) within the organization.

facsimileNumber
The numerical schema designed to achieve contact via facsimile.

telephoneNumber
The numerical schema designed to achieve contact via telephone.

reason
The reason that a business document was accepted or rejected.

thisDocumentGenerationDateTime
The date-time stamp indicating when this document was generated.

thisDocumentIdentifier
Unique tracking identification number that identifies the business document being sent.

toRole
The role receiving the document in a business document exchange.

Business Data Entities

Name

Definition

ActionControl
Business action message control properties.

ActionIdentity
The collection of business properties that identify a business action.

PartnerRoleDescription
The collection of business properties that describe a business partners' role in a partner interface process.

ContactInformation
The collection of business properties that provide communication and address information for contacting a person, organization or business.

PartnerDescription
The collection of business properties that describe a business partners' identity and their function in a supply chain.

BusinessDescription
The collection of business properties that describe a business identity and location.

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

Fundamental Business Data Entities

Name

Definition

Data Type
Min

Max

Representation

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

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

EmailAddress
Electronic mail address.
String
1

CommunicationsNumber
The electro-technical communication number, e.g., telephone number, facsimile number, pager number.
String
1
30
X(30)

GlobalPartnerRoleClassificationCode
Code identifying a party's role in the supply chain.
String
1
255

GlobalBusinessIdentifier
A unique business identifier. The DUNS number is specified by RosettaNet.
Integer
9
9
9(9)

GlobalSupplyChainCode
Code identifying the supply chain for the partner's function.
String
1
255

GlobalPartnerClassificationCode
Code identifying a partner's function in the supply chain.
String
1
255

GlobalDocumentFunctionCode
Code identifying the function of a document as either a request or a response.
String
1
255

GlobalProcessIndicatorCode
Code identifying a business process.
String
1
255

DateTimeStamp
Specifies an instance in time. Based on the ISO 8601 specification where "CC" represents the century, "YY" the year, "MM" the month and "DD" the day. The letter "T" is the date/time separator and "hh", "mm", "ss.sss" represent hour, minute and second respectively. This representation is immediately followed by a "Z" to indicate Coordinated Universal Time. Informal format: CCYYMMDDThhmmss.sssZ
DateTime
13
20
9(8)X9(6)V9(3)X

ProprietaryDocumentIdentifier
Unique identifier, i.e. a numeric value or alphanumeric value, for a business document.
String
1

Name	Definition
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.
failedInitiatingDocumentDateTime	The date-time stamp indicating when the initiating document of the failed process was generated.
failedInitiatingDocumentIdentifier	Unique tracking identification of the failed process' initiating business document.
fromRole	The role initiating a business document exchange.
contactName	Name of the contact person(s) within the organization.
facsimileNumber	The numerical schema designed to achieve contact via facsimile.
telephoneNumber	The numerical schema designed to achieve contact via telephone.
reason	The reason that a business document was accepted or rejected.
thisDocumentGenerationDateTime	The date-time stamp indicating when this document was generated.
thisDocumentIdentifier	Unique tracking identification number that identifies the business document being sent.
toRole	The role receiving the document in a business document exchange.

Name	Definition
ActionControl	Business action message control properties.
ActionIdentity	The collection of business properties that identify a business action.
PartnerRoleDescription	The collection of business properties that describe a business partners' role in a partner interface process.
ContactInformation	The collection of business properties that provide communication and address information for contacting a person, organization or business.
PartnerDescription	The collection of business properties that describe a business partners' identity and their function in a supply chain.
BusinessDescription	The collection of business properties that describe a business identity and location.
ProcessIdentity	The collection of business properties that are used to identify a business process.

Name	Definition	Data Type	Min	Max	Representation
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
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
EmailAddress	Electronic mail address.	String	1
CommunicationsNumber	The electro-technical communication number, e.g., telephone number, facsimile number, pager number.	String	1	30	X(30)
GlobalPartnerRoleClassificationCode	Code identifying a party's role in the supply chain.	String	1	255
GlobalBusinessIdentifier	A unique business identifier. The DUNS number is specified by RosettaNet.	Integer	9	9	9(9)
GlobalSupplyChainCode	Code identifying the supply chain for the partner's function.	String	1	255
GlobalPartnerClassificationCode	Code identifying a partner's function in the supply chain.	String	1	255
GlobalDocumentFunctionCode	Code identifying the function of a document as either a request or a response.	String	1	255
GlobalProcessIndicatorCode	Code identifying a business process.	String	1	255
DateTimeStamp	Specifies an instance in time. Based on the ISO 8601 specification where "CC" represents the century, "YY" the year, "MM" the month and "DD" the day. The letter "T" is the date/time separator and "hh", "mm", "ss.sss" represent hour, minute and second respectively. This representation is immediately followed by a "Z" to indicate Coordinated Universal Time. Informal format: CCYYMMDDThhmmss.sssZ	DateTime	13	20	9(8)X9(6)V9(3)X
ProprietaryDocumentIdentifier	Unique identifier, i.e. a numeric value or alphanumeric value, for a business document.	String	1