//component options: START

:tablespec: width="100%",cols="2,5a,^1,2",options="header"
:component-option-name: util.boldLink(path[2], "component_option", value.group)
:endpoint-path-option-name: util.boldLink(path[2], "endpoint_path_option", value.group)
:endpoint-query-option-name: util.boldLink(path[2], "endpoint_query_option", value.group)
:last-cell-formats: |util.description(value) \
|util.valueAsString(value.defaultValue) \
|util.javaSimpleName(value.javaType)


== Component Options

The {doctitle} component supports 17 options, which are listed below.

[{tablespec}]
|===
| Name | Description | Default | Type
| ctgDebug                | Enable debug mode on the underlying IBM CGT client.     | false        | java.lang.Boolean
| eciBinding              | The Binding instance to transform a Camel Exchange to EciRequest and vice versa  |              | com.redhat.camel.component.cics.CICSEciBinding
| eciTimeout              | The ECI timeout value associated with this ECIRequest object. An ECI timeout value of zero indicates that this ECIRequest will not be timed out by CICS Transaction Gateway. An ECI timeout value greater than zero indicates that the ECIRequest may be timed out by CICS Transaction Gateway. ECI timeout can expire before a response is received from CICS. This means that the client does not receive the confirmation from CICS that a unit of work has been backed out or committed.   | 0            | short
| encoding                | The transfer encoding of the message.      | Cp1145       | java.lang.String
| gatewayFactory          | The connection factory to be use                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |              | com.redhat.camel.component.cics.pool.CICSGatewayFactory
| host                    | The address of the CICS Transaction Gateway that this instance connects to                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |              | java.lang.String
| lazyStartProducer       | Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. |              | boolean
| port                    | The port of the CICS Transaction Gateway that this instance connects to.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | 2006         | int
| protocol                | the protocol that this component will use to connect to the CICS Transaction Gateway.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           | tcp          | java.lang.String
| server                  | The address of the CICS server that this instance connects to                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |              | java.lang.String
| sslKeyring              | The full classname of the SSL key ring class or keystore file to be used for the client encrypted connection                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |              | java.lang.String
| sslPassword             | The password for the encrypted key ring class or keystore                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |              | java.lang.String
| configuration           | To use a shared CICS configuration                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |              | com.redhat.camel.component.cics.CICSConfiguration
| socketConnectionTimeout | The socket connection timeout                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |              | int
| password                | Password to use for authentication                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |              | java.lang.String
| userId                  | User ID to use for authentication                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |              | java.lang.String
| initialFlow             | When a JavaGateway instance connects to a remote Gateway, an initial flow takes place | false | java.lang.Boolean
| callType                | The CICS ECI call type | com.ibm.ctg.client.ECIRequest.ECI_SYNC | int
|===


// endpoint options: START
== Endpoint Options

The {doctitle} endpoint is configured using URI syntax:

[subs='+attributes']
----
cics://[interfaceType]/[dataExchangeType][?options]
----

With the following _path_ and _query_ parameters:
[#_path_parameters]
=== Path Parameters (2 parameters)

[{tablespec}]
|===
| Name | Description | Default | Type
| interfaceType    | The interface type, can be eci, esi or epi. at the moment only eci is supported. | eci | java.lang.String
a| dataExchangeType a| The kind of data exchange to use +
Enum value: +
 * commarea
 * channel | commarea |  com.redhat.camel.component.cics.support.CICSDataExchangeType
|===


[#_query_parameters]
=== Query Parameters (15 parameters)

[{tablespec}]
|===
| Name | Description | Default | Type
| ctgDebug                | Enable debug mode on the underlying IBM CGT client. | false        | java.lang.Boolean
| eciBinding              | The Binding instance to transform a Camel Exchange to EciRequest and vice versa |              | com.redhat.camel.component.cics.CICSEciBinding
| eciTimeout              | The ECI timeout value associated with this ECIRequest object. An ECI timeout value of zero indicates that this ECIRequest will not be timed out by CICS Transaction Gateway. An ECI timeout value greater than zero indicates that the ECIRequest may be timed out by CICS Transaction Gateway. ECI timeout can expire before a response is received from CICS. This means that the client does not receive the confirmation from CICS that a unit of work has been backed out or committed. | 0            | short
| encoding                | Encoding to convert COMMAREA data to before sending.  | Cp1145       | java.lang.String
| gatewayFactory          | The connection factory to use  |              | com.redhat.camel.component.cics.pool.CICSGatewayFactory
| host                    | The address of the CICS Transaction Gateway that this instance connects to  |    localhost          | java.lang.String
| port                    | The port of the CICS Transaction Gateway that this instance connects to.  | 2006         | int
| protocol                | the protocol that this component will use to connect to the CICS Transaction Gateway.  | tcp          | java.lang.String
| server                  | The address of the CICS server that this instance connects to  |              | java.lang.String
| lazyStartProducer       | Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. |              | boolean
| sslKeyring              | The full class name of the SSL key ring class or keystore file to be used for the client encrypted connection  |              | java.lang.String
| sslPassword             | The password for the encrypted key ring class or keystore |              | java.lang.String
| socketConnectionTimeout | The socket connection timeout |              | int
| password                | Password to use for authentication |              | java.lang.String
| userId                  | User ID to use for authentication  |              | java.lang.String
| initialFlow             | When a JavaGateway instance connects to a remote Gateway, an initial flow takes place | false | java.lang.Boolean
| callType                | The CICS ECI call type | com.ibm.ctg.client.ECIRequest.ECI_SYNC | int
|===
