Message Sender - Context

The sender may require context information to define additional information needed by the system to successfully send outgoing messages. Open Admin > External Message > Message Sender and navigate to the Context page.

Description of Page

Define the Context Type and Context Value, which contain parameters for senders when more information is required. See below for some examples of context for different types of senders.

Note: The values for the Context Type field are customizable using the Lookup table. This field name is SENDER_​​CTXT_​​FLG.

Where Used

Follow this link to open the data dictionary where you can view the tables that reference CI_​​XAI_​​SENDER.

Email Sender Context

The email sender is used by the business service that sends email messages real-time.

An email sender must point to the Message Class EMAILSENDER. In addition, the following context records should be defined for senders of this type.

Context Type Description
SMTP Host name The SMTP server host name.
SMTP Username The user ID used to access the SMTP server.
SMTP Password The password used to access the SMTP server.
Response Time Out The amount of time the system should wait for a real time response.

HTTP Sender

An HTTP sender is one that sends messages to an HTTP server using the HTTP protocol. HTTP senders should reference a Message Class of HTTPSNDR.

Various parameters are required to establish a session with the target HTTP server. You specify these parameters by defining a collection of context values for the sender. A set of context types related to HTTP variables is provided with the product. The following section describes the context types and where appropriate, indicates valid values.

Before defining the HTTP sender, you need to find out how the HTTP server on the other side expects to receive the request, and in particular, to answer the following questions:

Context Type Description Values
HTTP URL1 - URL9

Used to construct the URL of the target HTTP server.

Since the URL may be long and complex, you can break it into smaller parts, each defined by a separate context record. The full URL is built by concatenating the values in URL1 through URL9.

You may use substitution variables when entering values for URL parts.

HTTP Method The HTTP method used to send the message. POST or GET
HTTP Proxy Host If connecting to the remote system requires using an HTTP Proxy, then this context field can be used to configure the HTTP Proxy Host. If the Proxy Host is set, the Sender class must use the value specified to connect to the remote system via a proxy.
HTTP Proxy Port If connecting to the remote system requires using an HTTP Proxy, then this context field can be used to configure the HTTP Proxy Port. If the Proxy Port is set, the Sender class must use the value specified to connect to the remote system via a proxy. If the HTTP Proxy Host is not set, HTTP Proxy Port is ignored and the connection will be made directly to the remote system.
HTTP Transport Method Specifies the type of the message. You can either send the message or send and wait for a response. Send or sendReceive
HTTP Form Data

Used when the message is in the format of an HTML Form ( Content-Type: application/x-www-form-urlencoded).

This context specifies the form parameters (data) that should be passed in the HTTP message. Since a form may have multiple parameters, you should add a context record for each form parameter.

The value of a form parameter takes the format of x=y where x is the form parameter name and y is its value.

If y contains the string @XMLMSG@ (case sensitive) then this string is replaced by the content of the service response XML message.

If a context record of this type is defined for a sender, the sender uses the HTML Form message format to send the message even if @XMLMSG@ is not specified in one of the context records.

If a context record of this type is not defined for a sender, then the XML is sent with Content-Type: text/plain. When using POST it is put in the HTTP message body.

Always required when using the GET method. If you are using the GET method and do not specify a Form Data context record, no message is transferred to the HTTP server.

The MPL server builds formData by concatenating the individual parts.

You may use substitution variables when entering values for Form Data.

HTTP Login User The HTTP server may require authentication. Add a context record of this type to specify the login user to use.
HTTP Login Password The HTTP server may require authentication. Add a context record of this type to specify the login password to use.
HTTP Header

Sometimes the HTTP server on the other side may require the addition of HTTP headers to the message.

For each HTTP header that has to be specified you should add a context record with a value having the following format x:y where x is the header name and y is the value for the header

HTTP Time Out Indicates the amount of time to wait for a connection to be established with the remote system.  
Character Encoding Indicates if the message should be encoded. The sender will add to the HTTP's content type header the string ;charset=x where x is the value of this context and when sending the message it will encode the data in that encoding. UTF-8 or UTF-16
Response Time Out The amount of time the system should wait for a real time response.