Transports and Interfaces: Siebel Enterprise Application Integration > EAI Transports and Interfaces Overview > Using Named Subsystems for Transport Parameters >

Common EAI Transport Parameters


To configure the EAI Transports, you need to create named subsystems for data handling and connection parameters, as presented in Table 3. The data handling parameters are presented in Table 4. These parameters are common to every Transport method. After you create the named subsystems, you then need to specify these named subsystems as parameters in the service method argument or the business service user property.

Table 3. Dispatch Parameter Usage
When You Need to...
Use This Parameter...

...call any Business Service

DispatchService. This parameter must be used in conjunction with DispatchMethod.

...call any Business Service

DispatchMethod. This parameter must be used in conjunction with DispatchService.

...call the Dispatch Rule Set Business Service

DispatchRuleSet.

...call any Workflow

DispatchWorkflowProcess.

Table 4. Common Data Handling Parameters for Transport Methods
Parameter Name
Description

CharSetConversion

  • Default is None. The default value for this parameter should be used for self-describing content such as XML and MIME.
  • CharSetConversion specifies if and how a character set conversion needs to occur before or after sending or receiving data from the external system. Legal values are None, UTF-8, and UTF-16.

    When used with a Receive method, CharSetConversion implies that the external data being read is in whatever charset specified by this setting and must be converted to String. Therefore, the output <Value> is a String whenever CharSetConversion is specified. If no CharSetConversion is specified, the output <Value> is in binary and retains its original encoding.

    When used with a Send method, CharSetConversion defines the character set for the output data. The data in <Value> is converted to the character set specified by CharSetConversion.

Depending on the value of this parameter, transport business services do implicit character set conversions, if necessary. Note that same CharSetConversion is assumed for requests and responses.

ConverterService

Default is EAI XML Converter. This is the name of the business service to use for serializing property sets to a buffer and unserializing buffers to property sets. This parameter receives arguments through business service user properties if the converter service can accept them. Note that not any arbitrary service may be designated to be a converter service.

DispatchMethod

DispatchMethod parameter specifies the dispatch method. Specification of DispatchService is mutually exclusive with specification of a DispatchRuleSet or a DispatchWorkflowProcess. This parameter is only applicable for the ReceiveDispatch and ReceiveDispatchSend methods.

DispatchRuleSet

DispatchRuleSet specifies the name of the dispatch rule set for the Dispatcher Service. Specification of DispatchRuleSet is mutually exclusive with specification of DispatchWorkflowProcess or Dispatch Service. This parameter is only applicable for the ReceiveDispatch and ReceiveDispatchSend methods.

DispatchService

DispatchService specifies the dispatch service. Specification of DispatchService is mutually exclusive with specification of a DispatchRuleSet or DispatchWorkflowProcess. This parameter is only applicable for the ReceiveDispatch and ReceiveDispatchSend methods.

DispatchWorkflowProcess

DispatchWorkflowProcess specifies the name of the workflow process to dispatch to. Specification of DispatchWorkflowProcess is mutually exclusive with specification of DispatchRuleSet or Dispatch Service. This parameter is only applicable for the ReceiveDispatch and ReceiveDispatch Send methods.

IgnoreCharSetConvErrors

Default is False. This parameter specifies whether character set conversion errors should be ignored. If False, with any such errors, the transport service propagates the error.

Impersonate

Default is False. This parameter indicates whether or not the receiver will execute the incoming request using the default credentials of the receiver or those provided in the incoming XML document. If this parameter is set to True, the receiver will introspect the incoming XML document (<SiebelMessage> element) for the eaiusername and eaipassword credential attributes. If these credentials are found, the receive will attempt to relogin with the credential. If the Impersonate parameter is set to True and the credentials are not found or are not a valid Siebel username or password, an error message will be returned.

RollbackOnDispatchError

Default is True. This parameter indicates whether or not to roll back transport transaction if a Dispatch Method fails. This parameter is only available for the transactional transports MQSeries Server and MSMQ.

SiebelTransactions

Default is True. This parameter indicates whether or not to nest the Siebel transaction within the transport transaction. This parameter is only available for the transactional transports MQSeries Server and MSMQ. If this parameter is set to False, the transaction support is turned off at the transport level. This setting means that if the transaction fails, then there will not be a rollback at the Siebel transaction level.

Transports and Interfaces: Siebel Enterprise Application Integration