Message metadata

Metadata are pieces of information that can be attached to the messages handled by Activator. This topic describes the different ways you can use metadata in Activator and describes generic Activator metadata elements.

Where to use metadata

The following sections describe uses for metadata in Activator.

Pickups

You can configure pickups to attach metadata to messages Activator consumes from back-end applications or trading partners. See Message attributes tab.

You can set rules that direct inbound messages to specified deliveries, based on rules.

When using JMS as an application transport, metadata parameters are appended to the BytesMessage or TextMessage. See JMS transport configuration.

ebXML trading

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 also can be exchanged between Activator and a back-end system via application transports.

See See "ebXML message metadata".

Message Handler

The Activator Message Handler provides optional processing of inbound or outbound messages based on metadata attributes and actions

You can configure Message Handler to:

  • Copy messages to parties other than the sender or receiver
  • Reject messages
  • Perform custom processing using your own Java class
  • Override delivery exchanges
  • Rename production files
  • Select a message attributes template to associate with the message
  • Transform record formats

For details of Message Handler use and configuration see Message Handler.

Post processing

You can perform post-processing commands on each inbound message immediately after Activator has received, processed and written it to an application delivery. You also can execute post-processing commands after sending messages to partners. Activator by default passes seven items of message metadata to the post process. See Post-processing of consumed messages.

APIs

Metadata are used by all APIs, including Java inline processing and pluggable transports. Using APIs requires obtaining an extension to the basic Activator license.

Metadata definitions

This section lists generic metadata elements that are predefined in Activator.

For information about the metadata associated with message records, see Metadata for record file management.

The following elements are listed in the correct format:

Tip   When using metadata elements, make sure to use the proper case.
  • BusinessProtocol – Business protocol for the current packaging state. The value depends on a message’s state.
  • BusinessProtocolVersion – The business protocol version for the current packaging state of the message. The value depends on a message’s current state. The value indicates the version of the ProtocolSender or ProtocolReceiver handling a message. The value does not necessarily coincide to a specific packaging specification or RFC.
  • ConnectionId – An internal unique identifier of the embedded HTTP server connection through which to send a synchronous response after receiving a message from a partner.
  • ConsumptionExchangePointId – Unique ID of the application or partner exchange point where the message originated.
  • ConsumptionFilename – The file name of a message consumed by an application or trading pickup. The value is null if the message is retrieved from an exchange point that does not support naming.
  • ConsumptionUrl – The URL of the consuming exchange point. If null, the URL cannot be consumed from the exchange point or the message was not consumed.
  • ContentMimeType – The MIME type of the message payload. The following are commonly used types.
  • MIME type

    Description

    application/EDI-consent

    TRADACOMS messages

    application/EDIFACT

    EDIFACT messages

    application/EDI-X12

    X12 messages

    application/octet-stream

    Binary messages

    application/xml

    XML messages

  • For information about other MIME types see:
  • CoreId – Used internally by Activator.
  • Direction – The direction of a message relative to the sending party.
  • DocumentClass – The document class of the message payload (for example, X12, XML).
  • DocumentType – For EDI documents this is the business document type, such as 894 (invoice) or 850 (purchase order). For XML documents, the document type has to be parsed from the document. For ebXML, this is the message type (for example, StatusRequest, StatusResponse, Pong, Ping).
  • DocumentTypeId – The document type definition ID that describes a payload's document type.
  • DoNotReroute – Mark a message so that it is not rerouted.
  • DoNotSubmit2Tx – Mark a message to be ignored by the Submit2Tx action.
  • EdiControlId – For an EDI message payload, the control ID.
  • ediint.DocumentType – For an EDI document, the document type (for example, 850). This is similar to the DocumentType element, but this one is only for EDI documents.
  • ediint.DocumentVersion – The version or release information from the EDI message payload. This applies to X12 and EDIFACT documents.
  • ediint.IsMDN – If a message is a receipt, the value is true. Otherwise, it is false.
  • ExpirationTime – Message expiration date. This is the date the message can be purged.
  • FormPostAppName – Name of the web application that received a form post containing a document. This is not meant to be the actual J2EE web application name, but a name the user recognizes. For example, ui is the name of the Activator UI web application.
  • FormPostUrl – URL that received a form post containing a document.
  • IntegrationId – Integration ID of a message. This can be used, via inline processing or JMS metadata, to attach a customer-specific ID to a message.
  • IsChildPayload – This element has been deprecated.
  • IsDuplicate True if the message is detected to be a duplicate through the business protocol message ID. False otherwise.
  • IsParentPayload – This element has been deprecated.
  • JmsFileReference – A JMS property that provides the path to the payload.
  • MaxRetries – Used internally by Activator.
  • MinimumExpirationTime – Minimum message expiration date. The earliest date the message can be purged. The expiration date can be set to a date after this.
  • MQCorrelationID – CorrelationId field of a MQSeries message read from or written to the MQSeries Queue. Value is base 64 encoded.
  • MQExpiry – The Expiry field of an MQSeries message read from or written to an MQSeries queue.
  • MQMessageID – The MessageId field of MQSeries message read from or written to the MQSeries queue. Value is base 64 encoded.
  • MQPriority – The Priority field of an MQSeries message read from or written to an MQSeries queue.
  • MQReplyToQueueName – The ReplyToQueueName field of an MQSeries message read from or written to an MQSeries queue.
  • NextRetryNum – Used internally by Activator.
  • NextRetryTime – Used internally by Activator.
  • PackagedBusinessProtocol – Message protocol for the packaged (request or receipt) state.
  • PackagedBusinessProtocolVersion – Message protocol version of the unpackaged (request or receipt) state. The value indicates the version of the ProtocolReceiver handling a message. The value does not necessarily coincide with a specific packaging specification or RFC.
  • packagingLocation – For outbound email messages to an SMTP server, this metadata element enables you to specify where to place a payload in a packaged email message. This metadata element can be specified on an individual payload, or included in an MMD for multi-payload messages.
  • To use set this attribute for single payloads in the user interface, in the Message Handler click Add an attribute, enter the attribute name packagingLocation, and set the required value:
    • packagingLocation=Body – specifies that the payload is included as a email message body.
    • packagingLocation=Attachment (default) – specifies the payload is included as an email attachment.
  • pesit.callerId – The caller or sender ID (nspart).
  • pesit.serverId – The server or receiver ID (nrpart).
  • pesit.originalSenderId – The original sender ID.
  • pesit.finalDestinationId – The final destination ID.
  • pesit.filename – The PeSIT file name or logical name (IDF).
  • pesit.filelabel – The PeSIT file label or physical file name (nfname).
  • pesit.serviceParam – The PeSIT free-text field sent during the file creation process (param).
  • pesit.fileEncoding – Designates how the file is transferred, text or binary (ftype).
  • pesit.recordLength – The PeSIT file record length (frecl).
  • pesit.priority – The PeSIT transfer priority (pri). This has no effect on Activator behavior.
  • PreferredBusinessProtocol – Preferred message protocol for message processing.
  • ProductionFilename – The file name of a message sent to a back-end application or a partner. Typically, this is the same as ConsumptionFilename.
  • ProductionUrl – The URL where a message was sent to a back-end application or a partner via any transport. The value is not set (null) if the message has not been produced.
  • ReceiverPartyId – Used internally by Activator.
  • ReceiverPartyIds – Comma-separated list of internal unique IDs of the receiving parties.
  • ReceiverPartyName – The name of the receiver.
  • ReceiverRejectedReason – Used internally by Activator.
  • ReceiverRoutingId – The routing ID of the message receiver.
  • RefToMessageCoreId – A value for this element is provided when one message refers to another. Typically this would be in ebXML when a business response is sent that refers to a previous message. The value is the core ID of the related message.
  • Rejected – If a message is in the rejected state, the value is true. Otherwise, it is false.
  • RejectedReason – For a message in the rejected state, the reason for the rejection.
  • SenderPartyId – Used internally by Activator.
  • SenderPartyIds – Comma-separated list of internal unique IDs of the sending parties.
  • SenderPartyName – The name of the sender.
  • SkipMessageValidationTrue indicates message validation is not performed for a peer message (for example, pings).
  • StagedHttpClientId – The staged HTTP servlet client ID.
  • StagedHttpServletId – The staged HTTP servlet ID.
  • SubjectHeader – Enables setting the subject line of outbound messages sent via AS2 message protocols. For outbound messages, the subject line value can be set by adding SubjectHeader as a message attribute on application pickup exchanges or adding it to outbound message metadata documents. Activator sets the attribute and value on inbound e-mail and EDIINT messages.
  • SynchronousResponseRestId – Used internally by Activator.
  • TransportResponseCode – Used internally by Activator.
  • UnpackagedBusinessProtocol – Message protocol for the unpackaged (request or receipt) state.
  • UnpackagedBusinessProtocolVersion – Message protocol version of the unpackaged (request or receipt) state. The value indicates the version of the ProtocolReceiver handling a message. The value does not necessarily coincide with a specific packaging specification or RFC.
  • UserAnnotation – A comment attached by a user.

Related topics

Related Links