11/16/21, 4:40 PM

Headers and Exchange Properties Provided by the Integration Framework 

Headers and Exchange Properties

Show 10 entries. Previous 1 Next Show/hide columns

Search: Search the entire table

Name Type (Property or Header) Related Component Description

Search within the column Search within the column Search within the column Search within the column

Archived-At Header Mail adapter Specifies a link to the archived form of an e-mail.

CamelAggregatedCompletedBy Header Aggregator Is relevant for use cases with message aggregation.

The header attribute can only have one of the following values:

timeout

Processing of the aggregate has been stopped because the

configured Completion Timeout has been reached.

predicate

Processing of the aggregate has finished because the

Completion Condition has been met.

CamelCharsetName Property Encoder Specifies the character encoding to be applied for message
processing.

Is relevant for content encoding steps.

CamelFileName Header SFTP Receiver adapter Overrides the existing file and directory name that is set
directly in the endpoint.

You can use this header to dynamically change the name of the file and directory to be
called.

If you do not enter a file name in the SFTP receiver adapter, the
content of the CamelFileName header (if set) is
used as file name. If this header is not specified, the
Exchange
ID is used as file name.

CamelHttpMethod Header HTTPS Sender adapter Refers to the HTTP method name of the incoming request (GET,
POST, PUT,
DELETE, and so on).

The HTTPS sender adapter sets this header.

CamelHttpPath Header HTTPS Sender adapter Refers to the dynamic part of the URL path of the integration
flow endpoint.

As an example, assume that you specify the endpoint address (in

the sender adapter) as /myEndpoint/*.

A sender system calls this integration flow using the address

/myEndpoint/abc/def.

In this case, header CamelHttpPath gets the

value abc/def.

CamelHttpQuery Header HTTPS Sender adapter Refers to the query string that is contained in the request URL
(for example, CamelHttpQuery=abcd=1234).

HTTP Receiver adapter The HTTPS sender adapter sets this header.

In the context of a receiver adapter, this header can be used to

dynamically change the URI to be called.

CamelHttpResponseCode Header HTTPS Sender adapter You can use this header to manually set the HTTP response status code.

CamelHttpUri Header HTTPS Sender adapter Overrides the existing URI set directly in the endpoint.

You can use this header to dynamically change the URI to be called.

1/8
11/16/21, 4:40 PM

Name Type (Property or Header) Related Component Description

Search within the column Search within the column Search within the column Search within the column

CamelHttpUrl Header HTTPS Sender adapter Refers to the complete URL called, without query parameters.

For example,
CamelHttpUrl=https://test.bsn.neo.ondemand.com/http/hello.

The HTTPS sender adapter sets this header.

CamelServletContextPath Header HTTPS Sender adapter Refers to the path specified in the address field of the channel.

For example, if the address in the channel is /abcd/1234, then

CamelServletContextPath is
/abcd/1234.

The HTTPS sender adapter sets this header.

CamelSplitComplete Property Splitter Indicates whether an Exchange is the last split.

CamelSplitIndex Property Splitter Provides a counter for split items that increases for each
Exchange that is split (starts from 0).

CamelSplitSize Property Splitter Provides the total number of split items (if you are using
stream-based splitting, this header is only provided for the
last item, in other words, for the completed
Exchange).

CamelXmlSignatureTransformMethods Header XML signer Specifies transformation methods in a comma-separated list.

You can use this header to specify transformation methods in a

comma-separated list. This header will overwrite the value of
the option Transform Method for
Payload.

 Sample Code
Example of this use case: The XML signature
verifier of the receiving system expects an XML signature as
shown in the following code snippet.

The signature is a
detached signature, because the signature element is a
sibling of the signed element B. However, the receiving
system requires the
enveloped-signature transform method to
be specified in the Transforms list. To ensure this, you
have to configure a detached signature in the XML Signer
step,
then add a Content Modifier step before the XML Signer
step, where you specify the header
"CamelXmlSignatureTransformMethods" with the constant value
“http://www.w3.org/2000/09/xmldsig#enveloped-signature,http://www.w3.org/TR/2001/REC-xml-c14n-20010315".

<?xml version="1.0" encoding="UTF-8" ?>

<root>

<B ID="IDforB">

...

</B>

<ds:Signature xmlns:ds="http://www.w3.org/2000/09/xmldsig#"

Id="_6bf13099-0568-4d76-8649-faf5dcb313c0">

<ds:SignedInfo>

...

<ds:Reference URI="#IDforB">

<ds:Transforms>

<ds:Transform Algorithm="http://www.w3.org/2000/09/xmldsig#enveloped-signature" />

2/8
11/16/21, 4:40 PM

Name Type (Property or Header) Related Component Description

Search within the column Search within the column Search within the column Search within the column
<ds:Transform Algorithm="http://www.w3.org/TR/2001/REC-xml-c14n-20010315" />

</ds:Transforms>

...

</ds:Reference>

</ds:SignedInfo>

<ds:SignatureValue>aUDFmiG71</ds:SignatureValue>

</ds:Signature>

<root>

CamelXmlSignatureXAdESDataObjectFormatEncoding Header XML Signer Specifies the value of the Encoding element of
the DataObjectFormat element.

CamelXmlSignatureXAdESNamespace Header XML Signer Overwrites the namespace parameter value.

CamelXmlSignatureXAdESPrefix Header XML Signer Overwrites the prefix parameter value.

CamelXmlSignatureXAdESQualifyingPropertiesId Header XML Signer Specifies the Id attribute value of the

QualifyingProperties element.

CamelXmlSignatureXAdESSignedDataObjectPropertiesId Header XML Signer Specifies the Id attribute value of the

SignedDataObjectProperties element.

CamelXmlSignatureXAdESSignedSignaturePropertiesId Header XML Signer Specifies the Id attribute value of the

SignedSignatureProperties element.

Cc Header Mail Receiver adapter Additional e-mail address that the message is sent to.

Content-Encoding Header HTTP Receiver adapter The encoding used during message transport (for example, gzip for GZIP
file compression).

This information is used by the receiver to retrieve the media type that is referenced by
the content-type header.

If this header is not specified, the default value

identity (no compression) is used.

More information: https://tools.ietf.org/html/rfc2616 (section

14.11)

The list of available content types is maintained by the Internet

Assigned Numbers Authority (IANA). For more information,
see:http://www.iana.org/assignments/http-parameters/http-parameters.xhtml#content-coding .

3/8
11/16/21, 4:40 PM

Name Type (Property or Header) Related Component Description

Search within the column Search within the column Search within the column Search within the column

Content-Type Header HTTP Receiver adapter HTTP content type that fits to the body of the request.

Mail Receiver adapter The content type is composed of two parts: a type and a
subtype.For example, image/jpeg (where
image is the type and jpeg
is the subtype).

Examples:

text/plain for unformatted text

text/html for text formatted with HTML

syntax

image/jpeg for a jpeg image file

application/json for data in JSON format

to be processed by an application that requires this
format

More information on the available types: https://www.w3.org/Protocols/rfc1341/4_Content-Type.html

The list of available content types is maintained by the Internet

Assigned Numbers Authority (IANA). For more information, see
http://www.iana.org/assignments/media-types/media-types.xhtml .

 Note
If transferring text/* content types, you
can also specify the character encoding in the HTTP header
using the charset parameter.

Here is an example of such a header:

Content-Type: text/html; charset=utf-8

The default character encoding that will be applied for

text/* content types depends on the
HTTP version: us-ascii for HTTP 1.0 and
iso-8859-1 for HTTP
1.1.

Text data in string format is converted using UTF-8 by

default during message processing. If you want to override
this behavior, you can use the Content
Modifier step and
specify the CamelCharsetName Exchange
property. To avoid encoding issues when using this feature
together with the HTTP adapter,
consider the following
example configuration:

If you use a Content Modifier step and you want to send

iso-8859-1-encoded data to a receiver,
make sure that you specify the
CamelCharsetName Exchange
property
(either header or property) as iso-8859-1.
For the Content-Type HTTP header, use text/plain;
charset=iso-8859-1.

Date Header Mail adapter The date and time when the e-mail was sent.

From Header Mail adapter Email address that the message comes from.

JMSTimestamp Header JMS Consumer Time when a JMS message was created.

Message-ID Header Mail adapter ID that the mail system assigned to the e-mail when it was first created.

Reply-to Header Mail adapter Message ID of the message that this e-mail is a reply to.

SAP-PASSPORT Header Stores the encoded SAP-Passport value from which an instance of
DSRPassport can be created. This header and the passport format
is specified for all SAP
solutions.

SAP_ApplicationID Header When you monitor the messages at runtime, you can search for all messages whose defined
SAP_ApplicationID has a specific
value (displayed as the MessageID
attribute in the Message Monitoring editor).

 Note
Only the first
120 characters are displayed.

As Type, select the XPath expression that

points to the message element that is to be used as the
application ID.

4/8
11/16/21, 4:40 PM

Name Type (Property or Header) Related Component Description

Search within the column Search within the column Search within the column Search within the column

SAP_CorrelateMPLs Property Specifies whether message processing logs (MPLs) are to be

correlated with each other using a correlation ID.

By default, MPL correlation is switched on. To specify this

property, select Constant as
Type and enter
True or False
as Value.

SAP_DataStoreCreatedAt Header Data Store The Data Store Get operation adds the timestamp information
Created At of the data story entry
(in milliseconds since 01 Jan 1970 00:00:00 UTC).

SAP_DataStoreExpiresAt Header Data Store The Data Store Get operation adds the timestamp information
Retain Until of the data story entry
(in milliseconds since 01 Jan 1970 00:00:00 UTC).

SAP_DataStoreRetries Header XI Sender adapter Number of retries of a message.

XI Receiver adapter The XI adapter sets this header (when as Quality of Service you
have selectedExactly Once and as
Temporary Storage you have chosen the
option Data Store).

You can use this header to specify that the behavior of the integration flow changes
depending on the number of retries that are actually performed.
For example,
you can use this header to define that after a
certain number of retries the message is routed to a specific
receiver (for example, to send an alert message to a
recipient).

You can use this header in case you configure the XI adapter with
Data Store as temporary storage.

SAP_ERiCResponse Header ELSTER Receiver adapter The ELSTER receiver adapter sets this header. It contains a
technical status created by the ERiC (ELSTER Rich
Client) library.

SAP_ErrorModelStepID Property You can use this property to set a Model Step ID for an
integration flow step. This identifier is required to relate to
an integration flow step in error handling.

SAP_FtpAfterProc Property SFTP Receiver adapter You can use this property to dynamically specify the
Handling for Existing Files
parameter.

SAP_FtpAuthMethod Property SFTP Receiver adapter You can use this property to dynamically specify the
Authentication parameter.

SAP_FtpCreateDir Property SFTP Receiver adapter You can use this property to dynamically specify the
Create Directories parameter.

FTP Receiver adapter

SAP_FtpDisconnect Property SFTP Receiver adapter You can use this property to dynamically specify the
Automatically Disconnect
parameter.

FTP Receiver adapter

SAP_FtpEncryption Property FTP Receiver adapter You can use this property to dynamically specify the
Encryption parameter.

SAP_FtpFastExistsCheck Property SFTP Receiver adapter You can use this property to dynamically specify the
Use Fast Exists Check parameter.

SAP_FtpFlattenFileName Property SFTP Receiver adapter You can use this property to dynamically specify the
Flatten File Name parameter.

FTP Receiver adapter

SAP_FtpMaxReconDelay Property SFTP Receiver adapter You can use this property to dynamically specify the
Reconnect Delay parameter.

FTP Receiver adapter

SAP_FtpMaxReconnect Property SFTP Receiver adapter You can use this property to dynamically specify the
Maximum Reconnect Attempts
parameter.

FTP Receiver adapter

SAP_FtpPdUri Property SFTP Receiver adapter You can use this property to dynamically retrieve a known_hosts
file from the Partner Directory.

SAP_FtpProxyType Property SFTP Receiver adapter You can use this property to dynamically specify the
Proxy Type parameter.

FTP Receiver adapter

SAP_FtpStepwise Property SFTP Receiver adapter You can use this property to dynamically specify the
Change Directories Stepwise
parameter.

FTP Receiver adapter

5/8
11/16/21, 4:40 PM

Name Type (Property or Header) Related Component Description

Search within the column Search within the column Search within the column Search within the column

SAP_FtpTimeout Property SFTP Receiver adapter You can use this property to dynamically specify the
Timeout parameter.

FTP Receiver adapter

SAP_MAIL_ENCRYPTION_DETAILS_DECRYPTION_ALIAS Property Mail Sender adapter The alias used for decryption of an encrypted mail.
(String)

SAP_MAIL_ENCRYPTION_DETAILS_DECRYPTION_OK Property Mail Sender adapter The received mail was successfully decrypted (not set, true, false).
(boolean)

SAP_MAIL_ENCRYPTION_DETAILS_ENCRYPTED Property Mail Sender adapter The received mail was encrypted.
(boolean)

SAP_MAIL_ENCRYPTION_DETAILS_ERROR_MESSAGES Property Mail Sender adapter There is an error message if the mail could not be decrypted.
(String)

SAP_MAIL_SIGNATURE_DETAILS_CERTIFICATES (Array Property Mail Sender adapter The signer certificate.

of java.security.cert.X509Certificate)

SAP_MAIL_SIGNATURE_DETAILS_ERROR_MESSAGES Property Mail Sender adapter The error message for a failed verification.
(Array of String)

SAP_MAIL_SIGNATURE_DETAILS_VERIFICATION_OK Property Mail Sender adapter The result of the verification.

(Array of boolean)

SAP_MAIL_SIGNATURE_OVERALL_VERIFICATION_OK Property Mail Sender adapter Is true if all signatures could be validated.
(boolean)

SAP_MessageProcessingLogCustomStatus Property You can use this property to set an at most 40 characters alphanumeric custom status for
the current message processing log. The value is transferred as
CustomStatus attribute to the root part of
the message processing log and then stored in the message
processing log header table.

SAP_MessageProcessingLogID Header Contains the ID of the message processing log.

You can use this property to read the ID of the message

processing log (no write access supported).

SAP_MessageProcessingLogID Property Points to the message processing log for the respective Exchange.

You can use this property to read the ID of the message

processing log (no write access supported).

SAP_MessageProcessingLogLevel Header If this message header is present for an incoming message, the processing of this message exchange is written with the specified log level.
Allowed values are INFO,
NONE, DEBUG (case-insensitive). The header does not get filled by the runtime, so it
cannot be used to retrieve the currently set log level.

SAP_MessageType Header Makes an application-specific Message Type available for monitoring. When set in the
integration flow, this header will be stored in the message
processing log. Only
the first 100 characters are displayed.

SAP_PregeneratedMplId Header If an exchange is created whose IN-message is carrying this

header, the specified ID is used as message processing log ID.
In this case, the message processing logs
of all retry attempts
are grouped together under one header. The header, if used, has
to be a Base64-encoded UUID.

SAP_Receiver Header Makes available the name of the receiver to monitoring.

If you have specified SAP_Sender or

SAP_Receiver, the corresponding
values are displayed in the message processing log. If you
change the SAP_Receiver value
during
message processing, all values are added to the receiver field
in the message processing log as a comma-separated list. If you
don't want this behavior, you
can specify the exchange property
SAP_ReceiverOverwrite (see below).

6/8
11/16/21, 4:40 PM

Name Type (Property or Header) Related Component Description

Search within the column Search within the column Search within the column Search within the column

SAP_ReceiverOverwrite Property Defines the handling of the message header SAP_Receiver . If set to
true, the header
SAP_Receiver will be overwritten with the
new value in case a value is
assigned to the
SAP_Receiver header. If set to
false, the new value is added to the
already existent header content. The content is stored as a
comma-separated
list,

Default value: java.lang.Boolean.FALSE

This behavior is helpful in scenarios like,the multicast pattern,

for example, where a message is sent to several receivers and
all receivers are to be collected in the
MPL (not just the last
added header).

 Note
Example configuration:

Name:
SAP_ReceiverOverwrite

Type:
Constant

Value: True

SAP_Sender Header Makes available the name of the sender to monitoring.

If you have specified SAP_Sender or

SAP_Receiver, the corresponding
values are displayed in the message processing log. If you
change the SAP_Receiver value
during
message processing, all values are added to the receiver field
in the message processing log as a comma-separated list. If you
don't want this behavior, you
can specify the exchange property
SAP_ReceiverOverwrite (see below).

SapAuthenticatedUserName Header SOAP Sender adapter User name of the client that calls the integration flow.

XI Sender adapter If the sender channel is configured to use client certificate

authentication, no such header is set (as it is not available in
this case).

SapDataStoreId Header Data Store Entry ID used/set by the Data Store component.

SapDataStoreMaxResults Header Data Store Used dynamically overwrite the configured number of polled messages in case of Data Store
SELECT operation.

SapIDocDbId Header IDoc Sender adapter The IDoc receiver adapter sends a request and gets an XML
response.

IDoc Receiver adapter The adapter parses the XML response and generates this header from it. The header
contains the IDoc number from the receiver system (for example,
0000000000160816).

SapIDocTransferId Header IDoc Sender adapter This header contains the incoming IDoc number from the sending
system (for example, 0000000000166099).

IDoc Receiver adapter It corresponds to the field DOCNUM in the IDoc Adapter.

SapIDocType Header IDoc Sender adapter This header contains the IDoc type from the sending system (for example,
WPDTAX01).

IDoc Receiver adapter

SapInterfaceName Header XI adapter XI protocol header

SapInterfaceNamespace Header XI adapter XI protocol header

SAPJMSAlerttime Header JMS Consumer Specifies the time when an alert needs to be sent.

7/8
11/16/21, 4:40 PM

Name Type (Property or Header) Related Component Description

Search within the column Search within the column Search within the column Search within the column

SAPJMSRetries Header JMS Consumer Number of retries of a JMS message.

The JMS sender adapter sets this header.

You can use this header to specify that the behavior of the
integration flow changes depending on the number of retries that
are actually performed. For example,
you can configure a
scenario where a mail is sent to an administrator with the
message as an attachment and the integration flow is terminated
successfully after a
specified number of retries.

You can use this header in case you configure the XI adapter with
JMS Queue as temporary storage.

SAPJMSRetryAt Header JMS Consumer

SapMessageId Header SOAP (SAP RM) Sender adapter SAPRM, IDoc, and XI protocol header for the message identifier

XI adapter

IDoc Receiver adapter

SapMessageIdEx Header SOAP (SAP RM) Sender adapter SAPRM and XI protocol header for the message identifier

XI adapter

SapPlainSoapQueueId Header IDoc Sender adapter Only relevant if the receiver channel is SAPRM. The header
contains the QueueID from the receiver system.

SapReceiverParty Header XI adapter XI protocol header

SapReceiverService Header XI adapter XI protocol header

SapRefToMessageId Header XI adapter XI protocol header

SapRefToMessageIdEx Header XI adapter XI protocol header

SapSenderParty Header XI adapter XI protocol header

SapSenderService Header XI adapter XI protocol header

Sender Header Mail adapter Specifies the actual sender (acting on behalf of the e-mail
address stated in the From header).

SOAPAction Header SOAP adapter This header is part of the Web service specification.

Subject Header Mail adapter Specifies the subject of the e-mail message.

To Header Mail adapter Specifies the e-mail address that the message is sent to.

Showing 1 to 91 of 91 entries. Previous 1 Next

Related Information
Dynamic Parameters (Example)
About Headers and Exchange Properties

8/8