EPI resource adapter deployment parameters

The EPI resource adapter has the following deployment parameters. The tools used to configure these parameters are server specific. The default value is shown where appropriate. Parameters are optional unless indicated as required.

applid

In local mode, this parameter sets the APPLID used by the Client daemon and IPIC for CICS® connections. In remote mode, this field is used to identify the client connection to the Gateway daemon.

applidQualifier

In local mode, this parameter sets the APPLID QUALIFIER used by the Client daemon and IPIC for CICS connections. In remote mode, this field is used to identify the client connection to the Gateway daemon.

connectionURL

The URL of the CICS Transaction Gateway with which the resource adapter will communicate. The URL takes the form protocol://address. This parameter is required. These protocols are supported:

• tcp
• ssl
• local

For example, you might specify a URL of tcp://ctg.business.com. For the local protocol specify local:.

interceptPlugin

The class name of an intercept plug-in that can be used to test JEE components without a running CICS Transaction Gateway ( CICS TG) or CICS server. For more information see ../../progguide/topics/intercepting_eci_enable_jee.html

portNumber

The port on which the CICS Transaction Gateway is running. The default value is 2006. This parameter is not relevant if you are using the local protocol.

serverName

The name of the CICS server to connect to for all interactions through this resource adapter. If this parameter is left blank, the default CICS server is used (see Default server). This name is defined in the CICS Transaction Gateway configuration file. To use multiple servers within an environment, you must deploy several Connection Factories, each with a different serverName attribute. Each Connection Factory can use the same Resource Adapter.

socketConnectTimeout

The maximum time in milliseconds that a Java™ client application tries to open a socket connection to a remote Gateway daemon. The default value 0 means that no timeout is applied. The timeout is ignored for attempts to connect to a local Gateway.

userName

The CICS user ID to be used if no other security credentials are available. See Programming using the JEE Connector Architecture for more information.

A logonLogoff class is required if:

• The requested terminal is sign-on capable, or
• The CICS Server does not support sign-on capable terminals (for example, CICS Transaction Server for iSeries)

password

The password for the CICS user ID defined above.

clientSecurity

The fully qualified name of the ClientSecurity class to use in each interaction with CICS. This parameter is optional; if no value is given, no ClientSecurity class is used. For more information about the use of ClientSecurity classes, and how to write them, see CICS Transaction Gateway security classes.

serverSecurity

The fully qualified name of the ServerSecurity class to use in each interaction with CICS. This parameter is optional; if no value is given, no ServerSecurity class is used. For more information about the use of ServerSecurity classes, and how to write them, see CICS Transaction Gateway security classes.

keyRingClass

The fully qualified name of the SSL key ring to use. This applies only when using the SSL protocol.

keyRingPassword

The password for the key ring defined in keyRingClass. Because it is linked to keyRingClass, it is also optional, and applies only to the SSL protocol.

signonType

The EPI resource adapter allows you to define whether the CICS terminals used by the resource adapter are sign-on capable. Enter one of the following:

0

Sign-on capable terminal (default)

1

Sign-on incapable terminal

For information about sign-on capability, see Sign-on capable and sign-on incapable terminals.

encoding

The Java Encoding to use when creating 3270 data streams. The encoding is converted to the appropriate CCSID. See Supported conversions for a list of supported encodings. Ensure that your CICS Server supports the CCSID for the given encoding.

logonLogoffClass

The fully qualified name of the Java Class that provides the logic to log on to a CICS Server using sign-on transactions. This property is mandatory for sign-on capable terminals and for CICS servers that do not support sign-on capability (such as CICS Transaction Server for iSeries). See Writing LogonLogoff classes for information about LogonLogoff classes.

deviceType

The Terminal Model type, as defined in CICS, to be used by this resource adapter.

readTimeout

The maximum time a CICS server waits for a response from a user or JEE component when taking part in a conversational transaction. Values for this parameter are:

0

No timeout.

1– 3600

Time in seconds.

installTimeout

The timeout value for terminal installation on CICS. Values for this parameter are as follows:

0

No timeout.

1– 3600

Time in seconds.

traceLevel

The level of trace to be output by the resource adapter. For more details on trace levels and tracing see Tracing.

cipherSuites

The cipherSuites parameter can be used when establishing an SSL connection. In the IBM® WebSphere® Administration console, change the cipherSuites custom property for the connection factory to a comma-separated list of the cipher suites that this connection factory is restricted to use.

requestExits

This field is not used by the EPIResourceAdapter and should be left blank.