<Value>

User-Defined Message Text

Input and Output data passed as a string. This is the value stored in the Value field of the property set, either input or output. If you specify the HTTPRequestBodyTemplate, the <Value> parameter is ignored and the HTTPRequestBodyTemplate parameter is used instead.

CharSetConversion

Character Set Conversion for Text Data

Character set conversion from the external system. The default is None.

ConnectionSubsystem

Connection Subsystem

Subsystem containing connection parameters.

ConverterService

Converter Service

Business service used to serialize and unserialize hierarchical data to raw buffer and the reverse. Must implement the DocToHier and HierToDoc methods. The default is EAI XML Converter.

DataHandlingSubsystem

Data Handling Subsystem

Subsystem containing data handling parameters.

EndOfData

End of Data

Output parameter whose value is True if the end of the data has been reached.

HTTPAccept

HTTP Accept

Default is text/*. The explicit value for the Accept: header to override the default. Specifies the MIME types accepted by the sender.

HTTPAllowCaching

Allow Caching

Default is N. By default, the responses for specific URL addresses are not cached by the EAI HTTP Transport. Set this flag to Y to enable caching.

Note that this can lead to undesirable side effects, as old data from earlier requests can be exposed from the cache buffer.

HTTPAllowPersistentCookies

Allow Persistent Cookies

Default is N. A session cookie is used to tie requests and logoff operations to the user session started at the login, when communicating with any session-cookie-based system. Leaving this flag set to N leaves the persistence of cookies in the control of the EAI HTTP transport, which is the default behavior.

All session cookies persist in memory only as long as the current session. Session cookies are not written to disk.

If you want to use persistent cookies, that is, if persistence between logins is required and you want cookies written to disk, then set the parameter to Y.

HTTPCertAuthority

HTTP Cert Authority

The name of the authority that issues the mutual authentication certificate, in RDN (Relative Distinguished Name) format.

For example:

CN=ServerName123, OU=Department, O=organization, L=Location, C=Country, E=email@domain.com

represents a certificate issued by Microsoft Certificate Authority running on the server ServerName123. RDN notation is case insensitive.

For information on configuring client SSL authentication, see Siebel Security Guide.

HTTPCertSerialNo

HTTP Cert Serial No

The mutual authentication certificate serial number, in hexadecimal format as a string without space characters in between. For example, the serial number "19 8b 11 d1 3f 9a 8f fe 69 a0" must be provided as:

198b11d13f9a8ffe69a0

Serial numbers are case insensitive.

For information on configuring client SSL authentication, see Siebel Security Guide.

HTTPContentType

HTTP Content Type

Default is application/xxx-form-urlencoded. The explicit value for the Content-Type: header to override the default. Specifies the type of data sent in the body of the request.

HTTPImplicitCharsetDetection

Implicit Character Set Detection

Default is False. This is the implicit character set detection for incoming data. Do not set it to True for self-describing documents such as XML. If set to True, this overrides the CharSetConversion parameter.

HTTPLoginBodyTemplate

Login Body Template

Specifies the HTTP request body that is used when HTTPLoginURLMethod is POST. By putting login information into the HTTP body (as opposed to putting it into the URL) for sending, this method provides stronger security than sending the login information in the URL. Generally, the login parameters in a login query are specified in the body of the request that uses the POST method.

Required for session mode only if the HTTPLoginMethod parameter is set to POST.

HTTPLoginMethod

Login Method

HTTP method to be used for logging in. If no Login Method is specified, this parameter defaults to the HTTPRequestMethod value.

Required for session mode.

HTTPLoginURLTemplate

Login URL Template

Template for the URL used for the login operation. This operation is separate from the request operation and assumes communication mode is session mode. If there is a separate login, one or more request and response messages are expected.

Required for session mode.

HTTPLogoffMethod

Log Off Method

Defaults is HTTPLoginMethod. HTTP method to be used for logging off.

Required for session mode.

HTTPLogoffURLTemplate

Log Off URL Template

Template for the URL that is used for the logoff operation. This operation is separate from the request operation and assumes that the mode of communication is session mode. If set, the logoff operation will be completed. Otherwise, logoff is skipped. The purpose of the logoff operation is to end a session that was started with the corresponding login.

Required for session mode.

HTTPMaxIdleSeconds

Max Idle Seconds

Maximum number of seconds to allow connections to be idle. After the elapsed max idle time, the connection is invalidated and restarted.

HTTPNoAutoRedirect

No Auto Redirect

Default is N. This means auto-redirect is enabled. Setting this parameter to Y disables auto-redirection of messages to other URLs.

HTTPRequestBodyTemplate

Request Body Template

HTTP Body to use with the POST method. This overrides any body specified in the Value field of the input property set.

HTTPRequestMethod

Request Method

HTTP method to use with the data request, such as Post or Get.

Required for both session and sessionless modes.

HTTPRequestURLTemplate

Request URL Template

Template for the request URL, which is the address to which the data is sent or from which a response is requested.

Required for both session and sessionless modes.

HTTPSleepTime

Sleep Time

Default is 120000 milliseconds. The timeout interval on login, send, and logoff requests in milliseconds.

HTTPUserAgent

HTTP User Agent

Default is Mozilla/4.0. The explicit value for the User-Agent: header to override the default. Specifies the name/version of the client program.

IgnoreCharSetConvErrors

Ignore Character Set Conversion Errors

Ignore character set conversion errors if True. Else, propagate the errors to the caller (default behavior).

TimedOut

Timed Out

True if receive timed out and no data was available. False if request completed.