ebXML message metadata

To comply with ebXML standards, Activator supports message metadata elements with message payloads. The metadata elements are information about message payloads, such as the identity of the CPA to use for message processing.

Metadata are exchanged between Activator and a back-end system via the following application transports:

  • JMS (inbound and outbound)
  • File system (outbound)
  • File system with message metadata (inbound)
  • Web services API server (outbound)
  • Web services API client (inbound)

Supported ebXML application transports explains the role of these transports in more detail.

Related topics

ebXML metadata descriptions

The following describes the metadata elements for ebXML.

These elements are listed in the correct format. When using metadata elements, make sure to use the proper case.

  • AckRequested – Indicates whether a partner is asked to send a receipt upon receiving the message. Valid values are true and false. This element can be set per message.
  • AckSignatureRequested – If AckRequested is true, this indicates whether the partner is asked to sign the receipt. Valid values are true and false. This element can be set per message.
  • Action – Identifies an action within a Service that processes the message. The Action must be unique within the Service in which it is defined. The Service designer defines the value of the Action element.
  • ConversationId – A string identifying all consecutive messages belonging to the same collaborative business process instance. This is useful for monitoring and auditing purposes.
  • CPAId – Identifies the CPA that governs the collaboration between the trading parties. This matches the CPA ID in the CPA, not the name of the CPA XML file.
  • DuplicateElimination – Indicates whether the receiving message service handler should accept or reject duplicate messages. Valid values are true and false. This element can be set per message.
  • ebXML.Ack – A message service level acknowledgment message.
  • ebXML.AsyncMshSignal – Indicates that the ebXML message service level signal is used asynchronously.
  • ebXML.DigestAlgorithm – Defines the algorithm for computing the digest of the message.
  • ebXML.EncryptionRequested – Indicates whether the message must be encrypted.
  • ebXML.Error – Used for an ebXML message service level error message.
  • ebXML.Fault – Used for an ebXML message service level fault message.
  • ebXML.IsSyncResponse – Indicates a synchronous response.
  • ebXML.MshSignalType – Indicates the type of the message service level message.
  • ebXML.Payload.Description – The description for a payload. This attribute is optional. Multiple descriptions are supported. Each description key name should end with an index number. For example: ebXML.Payload.Description1, ebXML.Payload.Description2, ebXML.Payload.Description3, and so on.
  • ebXML.Payload.DescriptionLang – The language of the description for a payload. This attribute is required if a Description is included, but do not use if there is no Description. Multiple description languages are supported. Each description language key name should end with an index number. For example: ebXML.Payload.DescriptionLang1, ebXML.Payload.DescriptionLang2, ebXML.Payload.DescriptionLang3, and so on.
  • ebXML.Payload.SchemaLocation – The location of the schema for a payload. This attribute is optional.
  • ebXML.Payload.SchemaVersion – The version of the schema for a payload. This attribute is optional if schema location is used. If schema location is not used, do not use.
  • ebXML.Ping – Used for a message service level ping message. On success, a pong message service level message must follow.
  • ebXML.Pong – Used for a message service level pong message. A pong message must be sent after having received a ping message service level message.
  • ebXML.ReceiveAction – Indicates the action taken.
  • ebXML.SignalType – Sets the message service level action of the message. The action can be an acknowledgment, error, message status request.
  • ebXML.SigningRequested – Indicates whether the ebXML message must be digitally signed.
  • ebXML.StatusRequest – Used to make a request about a previous ebXML message.
  • ebXML.StatusResponse – The response to a request about a previously sent ebXML message.
  • ebXML.StatusResponse.RefToMsgId – References the message the requesting message service level message was inquiring for status.
  • ebXML.SyncMshSignal – Indicates the message service level signal is used synchronously.
  • FromRole – The role of the sending party.
  • Hl7Version – Indicate the version of the HL7 message.
  • IsHl7 – Indicates the payload is an HL7 message.
  • IsStarBOD – Set to true for business object documents (BODs) that conform to Standards for Technology in Automotive Retail (STAR). Otherwise, set to false. See STAR BODs with ebXML.
  • MessageId – A unique identifier for a message that conforms to RFC 2822 .
  • ProcessSpecName – Defines the underlying business process specification.
  • ProcessSpecUUID – Unique identifier of the BPSS ProcessSpecification.
  • ReceiverRoutingIdType – The ebXML party ID type of the message receiver.
  • RefToMessageId – When present, this must have a MessageId value of an earlier message to which this message relates. If there is no related earlier message, this element must not be used.
  • SenderRoutingIdType – The ebXML party ID type of the message sender.
  • Service – Identifies the collaborative business process. This can be bound to a service in back-end integration.
  • ServiceType – An option of the Service element, it is required only when the trading partners require a type to properly identify the service. If the Service is not a URI, a type must be specified.
  • SyncReply – Indicates whether a response is used (such as a message level acknowledgment of a message for reliable messaging purposes). For example, instead of returning an HTTP code of 200 indicating success of a received ebXML message and then opening a new connection to send the message level acknowledgment back, the message level acknowledgment is sent over the same HTTP connection. The value of SyncReply can be true or false.
  • TimeToLive – If used, this indicates the time, expressed as universal time, that a message must be delivered. This attribute is optional.
  • ToRole – The role of the receiving party. Indicates the role the party is playing in the business transaction, such as the seller role.

MMD only

The following ebXML metadata elements are used only in message metadata documents.

  • RemovePayloadAfterProcessing – Indicates ( true or false) whether Activator deletes the payload from the file system after processing the message. (MMDs always are deleted after processing.) Use of this element is optional. If not used, the payload is not deleted, which is the same behavior as using the element with a value of false. If RemovePayloadAfterProcessing is true, payloads are deleted after being picked up. This also works for the resubmit case in which payloads are retrieved from the backup directory. This element only is for use in MMDs for outbound messages.
  • PayloadLocation – The directory path to the document.
  • PayloadLocationType – The path and file name of the payload. Payloads can be on a file system or an HTTP or FTP server, as the following examples illustrate:
  • File system

  • HTTP

  • FTP

  • In the FTP example, acme:acme in the URL represents the user name and password for connecting to the FTP server. Note: using an e-mail address as the password is not supported.
  • PayloadMimeContentId – An identifier of the payload content.
  • PayloadMimeContentType – The MIME type of the payload. For example, application/xml.

Required, optional metadata for back-end application integration

The following table lists required and optional metadata elements for all back-end application methods. The metadata elements are defined in ebXML metadata descriptions.

Element Name

Usage

AckRequested

Optional

AckSignatureRequested

Optional

Action

Optional

ConversationId

Optional

CPAId

Optional

DuplicateElimination

Optional

FromRole

Required

MessageId

Optional

PayloadLocation

MMD only

PayloadLocationType

MMD only

PayloadMimeContentId

MMD only

PayloadMimeContentType

MMD only

ProcessSpecName

Optional

ProcessSpecUUID

Optional

RefToMessageId

Optional

Service

Optional but recommended for reliable performance

ServiceType

Required only if Service is specified and it is not a URI.

TimeToLive

Optional

ToRole

Required

Related topics

Related Links