Header (-HDR)
Use the Header adapter command (-HDR) for data sources to specify inclusion of header information with the actual message.
-HDR
For data targets, the Header adapter command (-HDR) is not necessary. The adapter detects the presence of a header in the target data. The header data overrides any values specified for the corresponding elements with adapter commands.
The following header elements are used to return message attributes for data sources or to specify message attributes for data targets.
Attribute | For a Data Source | For a Data Target |
---|---|---|
Priority | This returns the priority with which the message was enqueued. | This specifies the message priority and overrides the Priority adapter command (-P). |
Delay | This returns the delay with which the message was enqueued. | This specifies the message delay and overrides the Delay adapter command (-D). |
Expiration | This returns the expiration with which the message was enqueued. | This specifies the message expiration and overrides the Expiration adapter command (-E). |
Correlation | This returns the correlation ID of the received message. | This specifies the message correlation ID and overrides the Correlation ID adapter command (-CID). |
Exception Queue | This value is always NONE. | This specifies the message exception queue and overrides the Exception Queue adapter command (-EQ). |
Sender | This value is always NONE. | This specifies the sender of the message and overrides the Sender adapter command (-S). |
Enqueue Time | This returns the time at which the message was enqueued. The format
is: YYYY-MM-DD HH24:MI:SS |
On output, this value is ignored. |
Recipients | This value is always NONE. | This specifies the comma-separated list of recipients of the message and overrides the Recipient adapter command (-R). |
The format of header information is contained within an XML tag <Header> as follows:
<Header>
<Priority>... </Priority>
<Delay>... </Delay>
<Expiration>... </Expiration>
<Correlation>... </Correlation>
<ExceptionQueue>... </ExceptionQueue>
<Sender>... </Sender>
<EnqueueTime> ... </EnqueueTime>
<Recipients>... </Recipients>
</Header>