ServiceHeaderPartMessageGuideline Version 1.1 Build# 22
1 |
1 | ServiceHeader
|
2 |
1 | |-- ProcessControl
|
3 |
1 | | |-- TransactionControl
|
4 |
1 | | | |-- AttemptCount
|
5 |
1 | | | |-- Choice
|
6 |
| | | |-- ActionControl
| |
7 |
1 | | | | | |-- ActionIdentity
|
8 |
0..1 | | | | | | |-- description.FreeFormText
|
9 |
1 | | | | | | |-- GlobalBusinessActionCode
|
10 |
1 | | | | | | |-- InstanceIdentifier
|
11 |
1 | | | | | | |-- VersionIdentifier
|
12 |
1 | | | | | |-- GlobalDocumentFunctionCode
|
13 |
0..1 | | | | | |-- inResponseTo.ActionIdentity
|
14 |
1 | | | | | | |-- GlobalBusinessActionCode
|
15 |
1 | | | | | | |-- InstanceIdentifier
|
16 |
1 | | | | | |-- PartnerRoute
|
17 |
1 | | | | | | |-- fromPartner.PartnerDescription
|
18 |
1 | | | | | | | |-- BusinessDescription
|
19 |
1 | | | | | | | | |-- GlobalBusinessIdentifier
|
20 |
1 | | | | | | | |-- GlobalPartnerClassificationCode
|
21 |
1 | | | | | | |-- toPartner.PartnerDescription
|
22 |
1 | | | | | | | |-- BusinessDescription
|
23 |
1 | | | | | | | | |-- GlobalBusinessIdentifier
|
24 |
1 | | | | | | | |-- GlobalPartnerClassificationCode
|
25 |
0..1 | | | | | |-- PerformanceControlRequest
|
26 |
0..1 | | | | | | |-- timeToAcknowledgeAcceptance.TimeDuration
|
27 |
0..1 | | | | | | |-- timeToAcknowledgeReceipt.TimeDuration
|
28 |
0..1 | | | | | | |-- timeToPerform.TimeDuration
|
29 |
| | | |-- SignalControl
| |
30 |
1 | | | | | |-- inResponseTo.ActionIdentity
|
31 |
1 | | | | | | |-- GlobalBusinessActionCode
|
32 |
1 | | | | | | |-- InstanceIdentifier
|
33 |
1 | | | | | |-- InstanceIdentifier
|
34 |
1 | | | | | |-- PartnerRoute
|
35 |
1 | | | | | | |-- fromPartner.PartnerDescription
|
36 |
1 | | | | | | | |-- BusinessDescription
|
37 |
1 | | | | | | | | |-- GlobalBusinessIdentifier
|
38 |
1 | | | | | | | |-- GlobalPartnerClassificationCode
|
39 |
1 | | | | | | |-- toPartner.PartnerDescription
|
40 |
1 | | | | | | | |-- BusinessDescription
|
41 |
1 | | | | | | | | |-- GlobalBusinessIdentifier
|
42 |
1 | | | | | | | |-- GlobalPartnerClassificationCode
|
43 |
1 | | | | | |-- SignalIdentity
|
44 |
1 | | | | | | |-- GlobalBusinessSignalCode
|
45 |
1 | | | | | | |-- VersionIdentifier
|
46 |
1 | | | |-- PartnerRoleRoute
|
47 |
1 | | | | |-- fromRole.PartnerRoleDescription
|
48 |
1 | | | | | |-- GlobalPartnerRoleClassificationCode
|
49 |
1 | | | | |-- toRole.PartnerRoleDescription
|
50 |
1 | | | | | |-- GlobalPartnerRoleClassificationCode
|
51 |
1 | | | |-- TransactionIdentity
|
52 |
0..1 | | | | |-- description.FreeFormText
|
53 |
1 | | | | |-- GlobalTransactionCode
|
54 |
1 | | | | |-- InstanceIdentifier
|
55 |
1 | | |-- ProcessIdentity
|
56 |
0..1 | | | |-- description.FreeFormText
|
57 |
1 | | | |-- GlobalProcessCode
|
58 |
1 | | | |-- GlobalProcessIndicatorCode
|
59 |
1 | | | |-- initiatingPartner.GlobalBusinessIdentifier
|
60 |
1 | | | |-- InstanceIdentifier
|
61 |
1 | | | |-- VersionIdentifier
|
62 |
1 | | |-- ServiceRoute
|
63 |
1 | | | |-- fromService.BusinessServiceDescription
|
64 |
1 | | | | |-- GlobalBusinessServiceCode
|
65 |
1 | | | |-- toService.BusinessServiceDescription
|
66 |
1 | | | | |-- GlobalBusinessServiceCode
|
1: ServiceHeader |
---|
User Notes: The root tag, to identify message headers that are from RosettaNet. |
2: ProcessControl |
---|
User Notes: Identifies the process envelope, which contains information relating to the RosettaNet process. An example of a RosettaNet process is "Manage Purchase Order". |
3: TransactionControl |
---|
User Notes: Identifies the transaction envelope, which contains information relating to the RosettaNet transaction. Examples of a RosettaNet transaction is "Purchase Order Request" and "Purchase Order Acceptance". |
4: AttemptCount |
---|
User Notes: Indicates whether a requesting message is the first attempt to execute this transaction, or a retry. The value is an integer 1 or greater. A value of 1 indicates a first attempt. A value greater than 1 indicates a retry attempt. When the attempt count is part of a responding transaction envelope it must contain the attempt count value of the requesting message. |
6: ActionControl |
---|
User Notes: Identifies the action envelope, which contains information relating to the RosettaNet action. Examples of a RosettaNet transaction are "Purchase Order Request". |
8: description.FreeFormText |
---|
User Notes: A free-form description of the action. This text is for ease of readability, is optional, and must not be used for any processing. |
9: GlobalBusinessActionCode |
---|
Entity Instances |
10: InstanceIdentifier |
---|
User Notes: A unique alpha-numeric identifier that represents a specific instance of an action. The action instance identifier must be unique for a particular instance of a transaction. |
11: VersionIdentifier |
---|
User Notes: This is the version number of the message guideline for this business action. |
12: GlobalDocumentFunctionCode |
---|
Entity Instances |
13: inResponseTo.ActionIdentity |
---|
Constraint: This element is mandatory when the document function code = Response and must not exist when the document function code = Request |
User Notes: In the case where this action is in response to an earlier action in the same transaction (i.e., a subscription confirmation), this block identifies the action to which this action is in response. An action instance identifier identifies the action to which this action is in response. The action code is given for readability purposes. The transaction instance identifier and the process instance identifier of the original message must be the same as the transaction instance identifier and process instance identifier of this message, and are therefore not specified. In the event that a business document is in response to another business document in a different transaction, the business document would reference the originating business document in the document body. |
14: GlobalBusinessActionCode |
---|
Entity Instances |
20: GlobalPartnerClassificationCode |
---|
Entity Instances |
24: GlobalPartnerClassificationCode |
---|
Entity Instances |
25: PerformanceControlRequest |
---|
Constraint: At least one of the sub elements must exist. |
26: timeToAcknowledgeAcceptance.TimeDuration |
---|
Constraint: The duration must be a positive duration i.e. there must be either no sign or the sign must be "+" |
27: timeToAcknowledgeReceipt.TimeDuration |
---|
Constraint: The duration must be a positive duration i.e. there must be either no sign or the sign must be "+" |
28: timeToPerform.TimeDuration |
---|
Constraint: The duration must be a positive duration i.e. there must be either no sign or the sign must be "+" |
29: SignalControl |
---|
User Notes: Identifies the business signal envelope, which contains information relating to the RosettaNet signal. Examples of a RosettaNet signal are "Acknowledge Receipt". |
30: inResponseTo.ActionIdentity |
---|
User Notes: Signals are sent in response to an action in the same transaction (i.e., an acknowledgement to a business document), this block identifies the action to which this signal is in response. An action instance identifier identifies the action to which this action is in response. The action code is given for readability purposes. The transaction instance identifier and the process instance identifier of the original message must be the same as the transaction instance identifier and process instance identifier of this message, and are therefore not specified. In the event that a business document is in response to another business document in a different transaction, the business document would reference the originating business document in the document body. |
31: GlobalBusinessActionCode |
---|
Entity Instances |
32: InstanceIdentifier |
---|
User Notes: A unique alpha-numeric identifier that represents a specific instance of an action. The action instance identifier must be unique for a particular instance of a transaction. |
33: InstanceIdentifier |
---|
User Notes: A unique alpha-numeric identifier that represents a specific instance of an signal. The signal instance identifier must be unique for a particular instance of a transaction. |
38: GlobalPartnerClassificationCode |
---|
Entity Instances |
42: GlobalPartnerClassificationCode |
---|
Entity Instances |
44: GlobalBusinessSignalCode |
---|
Entity Instances |
45: VersionIdentifier |
---|
User Notes: This is the version number of the message guideline for this business signal. |
48: GlobalPartnerRoleClassificationCode |
---|
Entity Instances |
50: GlobalPartnerRoleClassificationCode |
---|
Entity Instances |
52: description.FreeFormText |
---|
User Notes: A free-form description of the transaction. This text is for ease of readability, is optional, and must not be used for any processing. |
53: GlobalTransactionCode |
---|
Entity Instances |
54: InstanceIdentifier |
---|
User Notes: An alpha-numeric identifier that uniquely identifies a specific instance of this transaction within a specific instance of the process. Actions within the same instance of a transaction must have the same transaction instance identifier |
57: GlobalProcessCode |
---|
Entity Instances |
58: GlobalProcessIndicatorCode |
---|
Entity Instances |
60: InstanceIdentifier |
---|
User Notes: The combination of the process Instance Indentifier and the Global Business Indicator Code (DUNS number) for the partner that initiated a process uniquely identifies an instance of a process. Therefore, the ID of the initiating partner is contained within the process envelope. The initiating partner will remain constant over the life of the instance of this process. |
61: VersionIdentifier |
---|
User Notes: Version of the PIP specification. |
64: GlobalBusinessServiceCode |
---|
Entity Instances |
66: GlobalBusinessServiceCode |
---|
Entity Instances |
Name | Definition |
---|---|
description | A description of a process, thing, action, etc. |
inResponseTo | The business action that this message is responding to. |
fromPartner | The partner from which a message is being sent. |
toPartner | The partner to which a message is being sent. |
timeToAcknowledgeAcceptance | The time-out period for acknowledging acceptance of a business message. |
timeToAcknowledgeReceipt | The time-out period for acknowledging receipt of a business message. |
timeToPerform | The time-out period that a initiating business activity will wait for a responding activity to process a business document. |
fromRole | The role initiating a business document exchange. |
toRole | The role receiving the document in a business document exchange. |
initiatingPartner | The partner that initiated a process. |
fromService | The busines service from which a message is being sent. |
toService | The business service to which a message is being sent. |
Name | Definition |
---|---|
ServiceHeader | Processing control properties for RosettaNet Business Service messages. |
ProcessControl | Business process message control properties. |
TransactionControl | Business transaction message control properties. |
ActionControl | Business action message control properties. |
ActionIdentity | The collection of properties that are used to identify a business action. |
PartnerRoute | The route a message is on between supply chain partners. |
PartnerDescription | The collection of business properties that describes a business partners' identity and their function in a supply chain. |
BusinessDescription | The collection of business properties that describes a business identity and location. |
PerformanceControlRequest | Identifies the performance controls block, which details security, audit and process controls. This block is optional. If it is not specified, then the default PIP Business Activity Performance Controls should be used. Partners may agree to use more strin |
SignalControl | Business signal message control properties. |
SignalIdentity | The collection of properties that are used to identify a business signal. |
PartnerRoleRoute | The route a message is on between partner roles in a supply chain. |
PartnerRoleDescription | The collection of business properties that describes a business partners' role in a partner interface process. |
TransactionIdentity | The collection of properties that are used to identify a business transaction. |
ProcessIdentity | The collection of properties that are used to identify a business process. |
ServiceRoute | The route a message is on between business services. |
BusinessServiceDescription | A description of a business service network component. |
Name | Definition | Data Type | Min | Max | Representation |
---|---|---|---|---|---|
AttemptCount | Indicates whether this message is the first attempt to execute this transaction, or a retry. This element is optional and, when specified, should be an integer 1 or greater. If it is not specified, or is specified and has a value of 1, then this is the first attempt. A value greater than 1 indicates a retry attempt. | NaturalNumber | 1 |   |   |
FreeFormText | Unformatted text. | String | 1 |   |   |
GlobalBusinessActionCode | A phrase that specifies a business action. The code is found in table 4.2 of the PIP specification document. | 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 |   |   |
VersionIdentifier | A unique identifier specifying the version of an entity e.g. a product, a message format, or a standard. | String | 1 |   |   |
GlobalDocumentFunctionCode | Code identifying the function of a document as either a request or a response. | String | 1 |   |   |
GlobalBusinessIdentifier | A unique business identifier. The DUNS number is specified by RosettaNet. | Integer | 9 | 9 | 9(9) |
GlobalPartnerClassificationCode | Code identifying a partner's function in the supply chain. | String | 1 |   |   |
TimeDuration | A relative period of time specified as a single quantity. The lexical representation for this quantity is the [ISO 8601] representation CCYYMMDDThhmmss.sss, preceded by an optional sign (+ or -), where "CC" represents the number of centuries, "YY" the number of years, "MM" the number of months and "DD" the number of days. The letter "T" is the date/time separator and "hh", "mm", "ss.sss" represent number of hours, minutes and seconds respectively. Note that this representation allows for fractional seconds. For example, to indicate a duration of 1 year, 2 months, 3 days, 10 hours, and 30 minutes, one would write: 00010203T103000. | String | 15 | 20 | SCCYYMMDDThhmmss.sss |
GlobalBusinessSignalCode | Business signal message identifier | String | 1 |   |   |
GlobalPartnerRoleClassificationCode | Code identifying a party's role in the supply chain. | String | 1 |   |   |
GlobalTransactionCode | Service transaction dialog. The code is the name of the business activity and the transaction dialog in the PIP specification document. | String | 1 |   |   |
GlobalProcessCode | Business process identifier e.g. Manage Product Subscriptions. This code is the name of a PIP specification document. | String | 1 |   |   |
GlobalProcessIndicatorCode | An business process indicator e.g 1B1. This is the classification of the PIP specification by cluster identifier and segment identifier. | String | 1 |   |   |
GlobalBusinessServiceCode | Unique identity of a business service network component. This code is found in table 4.1 in a PIP specification document. | String | 1 |   |   |
Created using Edifecs Commerce e-Modeling Tools.