The inbound property settings determine the adapter's behavior for input operations.
The TCP/IP inbound adapter configuration parameters, accessed from the Connectivity Map, are organized into the following sections:
TCPIP Inbound Settings - Server Port Binding — TCP/IP Adapter Inbound.
TCPIP Inbound Settings - Client Connection Establishment — TCP/IP Adapter Inbound.
TCPIP Inbound Settings - Inbound Connection Management — TCP/IP Adapter Inbound.
TCPIP Inbound Schedules - Listener Schedule — TCP/IP Adapter Inbound.
TCPIP Inbound Settings - Service Schedule — TCP/IP Adapter Inbound.
TCPIP Inbound Settings - Envelope Message — TCP/IP Adapter Inbound.
Where to Go Next
General Inbound Settings — TCP/IP Adapter Inbound.
Related Topics
About Configuring Java CAPS Adapter Connectivity Map Properties
Configuring Java CAPS Project Components for Communication Adapters
Configuring Java CAPS Environment Components for Communications Adapters
The following section contains a brief description on upgrading the adapter Java CAPS 5.1.x to 6 Upgrade Procedure.
The General Inbound Settings properties provide the dedicated session mode and maximum data size message settings for the server. This section contains the top-level parameters as displayed in the table.
Table 111 Connectivity Map - General Inbound Settings
Where to Go Next
TCPIP Inbound Settings — TCP/IP Adapter Inbound.
Related Topics
About Configuring Java CAPS Adapter Connectivity Map Properties
Configuring Java CAPS Project Components for Communication Adapters
Configuring Java CAPS Environment Components for Communications Adapters
The TCPIP Inbound Settings properties provide the basic TCP/IP values for the server. The TCP/IP Inbound Settings properties contain the top-level parameters as displayed in the table.
Table 112 Connectivity Map - TCPIP Inbound Settings
Where to Go Next
TCPIP Inbound Settings - Server Port Binding — TCP/IP Adapter Inbound.
Related Topics
About Configuring Java CAPS Adapter Connectivity Map Properties
Configuring Java CAPS Project Components for Communication Adapters
Configuring Java CAPS Environment Components for Communications Adapters
The Server Port Binding section defines the configuration parameters used for controlling the server port binding. The TCP/IP Inbound Settings — Server Port Binding properties contain the top-level parameters as displayed in the table.
Table 113 Connectivity Map - TCPIP Inbound Settings - Server Port Binding
Name |
Description |
Required Value |
---|---|---|
Specifies the maximum number of times the adapter attempts to bind to the specified TCP/IP port on the localhost. |
An integer indicating the number of bind attempts. The configured default is 3. |
|
Specifies the amount of time (in milliseconds) the adapter waits between attempts to bind to the specified TCP/IP port on the localhost. |
An integer indicating the amount of time in milliseconds that the adapter waits between attempts. The configured default is 30000 (30 seconds). |
Where to Go Next
TCPIP Inbound Settings - Client Connection Establishment — TCP/IP Adapter Inbound.
Related Topics
About Configuring Java CAPS Adapter Connectivity Map Properties
Configuring Java CAPS Project Components for Communication Adapters
Configuring Java CAPS Environment Components for Communications Adapters
The Client Connection Establishment properties define some of the configuration parameters used for controlling the connection establishment. This section is used only when the Connection Type is set as Client.
This section of the TCP/IP inbound adapter Connectivity Map properties contains the top-level parameters as displayed in the table.
Table 114 Connectivity Map - TCPIP Inbound Settings - Client Connection Establishment
Name |
Description |
Required Value |
---|---|---|
Specifies the amount of time (in milliseconds) the adapter waits before attempting to connect to the external system. |
A number indicating the amount of time (in milliseconds) the adapter waits before attempting to connect to an external system. The configured default is 30000 (30 seconds). |
Where to Go Next
TCPIP Inbound Settings - Inbound Connection Management — TCP/IP Adapter Inbound.
Related Topics
About Configuring Java CAPS Adapter Connectivity Map Properties
Configuring Java CAPS Project Components for Communication Adapters
Configuring Java CAPS Environment Components for Communications Adapters
The Inbound Connection Management properties define the parameters used for inbound Server Connection Management. For example, the connection pool and the life cycle of the accepted connection.
This section of the TCP/IP HL7 inbound adapter Connectivity Map properties contains the top-level parameters is as displayed in the table.
Table 115 Connectivity Map - TCPIP Inbound Settings - Inbound Connection Management
Name |
Description |
Required Value |
---|---|---|
Specifies the maximum number of concurrent connections allowed for the specific listener/monitor which is listening or monitoring a specified TCP/IP port. This represents the capability or availability of this server’s services. Each connect-request from a client gains one concurrent connection. This parameter also represents the maximum number of clients who can concurrently connect to this server’s services, and get served by the specific listener/monitor at the same time. |
A number indicating the maximum number of concurrent connections available from a listener/monitor for a specific TCP/IP port. 0 indicates that there is no limit. The configured default is 50. |
|
Specifies the scope of the accepted connection which is used by the adapter. The two options are:
|
Select Resource Adapter Level or Collaboration Level. The configured default value is Resource Adapter Level. |
|
Specifies the close notification value. When the server receives a notification with content that matches this parameter’s value, the server safely closes the connection and cancels any corresponding schedules. |
A String indicating the trigger value that notifies the server to close the connection. The configured default is QUIT. |
|
Specifies the length of time (in milliseconds) for inactivity of the requestor (client). The adapter attempts to detect activity on client side (the other side of the connection). If no client activity (no i/o request comes over the connection from the client) for a specified time period, then the connection is closed from the server side to release the resource. The value is in milliseconds. |
An integer that indicates the amount of time (in milliseconds) for inactivity of the requestor (client) before the connection is closed from the server side to release the resource. A value of 0 disables IdleTimeout. The configured default is 60000 (1 minute). |
Where to Go Next
TCPIP Inbound Schedules - Listener Schedule — TCP/IP Adapter Inbound.
Related Topics
About Configuring Java CAPS Adapter Connectivity Map Properties
Configuring Java CAPS Project Components for Communication Adapters
Configuring Java CAPS Environment Components for Communications Adapters
This section configures the scheduler used by the inbound TCP/IP Server. The server waits for a new client connection establishment request. These parameters are used to configure the listener/monitor that listens on the specified port.
Two J2EE schedulers are available (see Scheduler):
Timer Service: This scheduler is configured using the At Fixed Rate, Delay, and Period properties.
Work Manager: Available for J2EE (JCA 1.5 and above). This scheduler is configured using the Delay and Period properties.
Both schedulers provide the functionality required by the inbound TCP/IP Server.
This section of the TCP/IP HL7 inbound adapter Connectivity Map properties contains the top-level parameters is as displayed in the table.
Table 116 Connectivity Map - TCPIP Inbound Schedules - Listener Schedule
Name |
Description |
Required Value |
---|---|---|
Specifies the scheduler type for this inbound communication. There are two options:
|
Select Timer Service or Work Manager. If your container doesn’t support JCA Work Manager, select Timer Service. |
|
This property configuration, though visible from the Properties Editor, is disabled. The only available schedule type is Repeated, indicating that the task is scheduled for repeated execution at regular intervals defined by the Period property in this section (see Period). |
This property is disabled. |
|
Applies to both the Timer Service or the Work Manager. Specifies, in milliseconds, the length of delay time before the task is executed. |
An integer indicating the amount of time before the task is executed, in milliseconds (1000 milliseconds is equal to 1 second). |
|
Specifies the regular interval, in milliseconds, between successive repeated task executions. This is used for the Repeated Schedule Type. See Schedule Type. Applies to both the Timer Service or the Work Manager. |
An integer indicating the amount of time between successive task executions, in milliseconds. Enter a positive integer. The configured default is 100. Lowering this value may increase the number of transactions per second. |
|
Specific to the Timer Service configuration only. Specifies whether a Fixed-Rate execution or Fixed-Delay execution is used.
|
Select True or False. True indicates that a fixed-rate execution is used. False indicates that a fixed-delay execution is used. |
Where to Go Next
TCPIP Inbound Settings - Service Schedule — TCP/IP Adapter Inbound.
Related Topics
About Configuring Java CAPS Adapter Connectivity Map Properties
Configuring Java CAPS Project Components for Communication Adapters
Configuring Java CAPS Environment Components for Communications Adapters
This section configures the scheduler used by the TCP/IP Server that executes the business tasks (Collaboration Rules) over the existing connection. This scheduler affects the actual Business Rules defined by the user.
Two J2EE schedulers are available (see Scheduler):
Timer Service: This scheduler is configured using the At Fixed Rate, Delay, Period, and Schedule Type properties.
Work Manager: Available for J2EE (JCA 1.5 and above). This scheduler is configured using the Delay, Period, and Schedule Type properties.
Both schedulers provide the functionality required by the inbound TCP/IP Server.
This section of the TCP/IP inbound adapter Connectivity Map properties contains the top-level parameters as displayed in the table.
Table 117 Connectivity Map - TCPIP Inbound Settings - Server Schedule
Name |
Description |
Required Value |
---|---|---|
Specifies the scheduler type for this inbound communication. There are two options:
|
Select Timer Service or Work Manager. If your container doesn’t support JCA Work Manager, select Timer Service . |
|
Applies to both the Timer Service or the Work Manager. Specifies whether the task is scheduled to occur once or be repeated.
|
Select OneTime or Repeated. |
|
Applies to both the Timer Service or the Work Manager. Specifies, in milliseconds, the length of delay time before the task is executed. |
An integer indicating the amount of time, in milliseconds, before the task is executed (1000 milliseconds is equal to 1 second). |
|
Specifies the wait interval in milliseconds between successive repeated task executions. This is used for the Repeated Schedule Type (see Schedule Type). Applies to both the Timer Service or the Work Manager. |
An integer indicating the amount of time, in milliseconds, between successive task executions (1000 milliseconds is equal to 1 second). Enter a positive integer. The configured default is 100. Lowering this value may increase the number of transactions per second. |
|
Specific to the Timer Service configuration only. Specifies whether a Fixed-Rate execution or Fixed-Delay execution is used. This is used for the “Repeated” schedule type by the “Timer Service” scheduler.
|
Select True or False. True indicates that a fixed-rate execution is used. False indicates that a fixed-delay execution is used. |
Where to Go Next
TCPIP Inbound Settings - Envelope Message — TCP/IP Adapter Inbound.
Related Topics
About Configuring Java CAPS Adapter Connectivity Map Properties
Configuring Java CAPS Project Components for Communication Adapters
Configuring Java CAPS Environment Components for Communications Adapters
This section of the Inbound TCP/IP adapter Connectivity Map properties contains the top-level parameters is as displayed in the table.
Table 118 Connectivity Map - TCPIP Inbound Settings - Envelope Message
Name |
Description |
Required Value |
||
---|---|---|---|---|
Specifies the envelope type. The envelope type defines where a message starts and stops. |
Enter one of the following properties denoting the envelope type:
The default is BeginEndMarked. |
|||
BeginEndMarked is supported by the properties Bytes to Read, Ignore Until Char Value, and Store Until Char Value. |
||||
EndMarked is supported by the property Store Until Char Value. |
||||
FixedLength is supported by the properties Bytes to Read. |
||||
LengthPrefixed is supported by the property Width of Length and Numeric Representation. |
||||
MarkedAndFixed is supported by the property Bytes to Read, Ignore Until Char Value, and Store Until Value. |
||||
PerActiveConnection is supported by the property PerActiveConnection. |
||||
Custom is supported by the properties Custom Enveloped Class Name and Custom Defined Property. Note – For all envelope types, except MarkedAndFixed, the data is just the payload. See MarkedAndFixed for an explanation of how the data is handled by that envelope type. |
||||
Specifies the Java class name to be used when the Envelope Type property is set to Custom. If you are using a custom envelope you have created, using a Java Class, you can import the Java JAR file containing the class into any desired Collaboration, using the Collaboration Editor's file import feature. The class name should be a full qualified class name, such as com.abc.MyClass. The class must implement interfaces
and
For more details, see Customized Enveloping. |
A full Java class name. A full qualified class name, or None if Custom is not the Envelope Type. The configured default is None. |
|||
Used when the Envelope Type value is set to Custom. Specifies a list of user-defined parameters. You can parse this information, such as delimiters, into your customized envelope message implementation. |
A text string. |
|||
Used with the following Envelope Types:
Specifies the number of bytes to read. It is assumed that all Events received by the adapter have the same length. |
An integer indicating the number of bytes. The configured default is 1. |
|||
Used for Envelope Type value LengthPrefixed. Specifies the width of the envelope length. In other words, it dictates the number of digits to be used to represent the length field. |
An integer, the range is 1 to 10. This property must be set to 2 for Network short and 4 for Network long. The configured default value is 1. |
|||
Used for Envelope Type value LengthPrefixed. Specifies how the number representation of the prefixed length is expressed. This value is expressed in one of the following formats:
|
Select one of the following:
The configured default is Decimal. |
|||
Used for the Envelope Types BeginEndMarked and MarkedAndFixed. Specifies the value for the ignore-until (same as begin block) character. All incoming characters are ignored until this character is encountered. |
A decimal ascii number. The allowed range is 1 to 127. The configured default is 11. |
|||
Used for Envelope Types BeginEndMarked, EndMarked, and MarkedAndFixed. Specifies the character in the End Block or Marker position of the envelope. All incoming characters are stored until this character is encountered. |
A decimal ASCII number. The allowed range is 1 to 127. The configured default is 12. |
Where to Go Next
Java CAPS 5.1.x to 6 Upgrade Procedure.
Related Topics
About Configuring Java CAPS Adapter Connectivity Map Properties
Configuring Java CAPS Project Components for Communication Adapters
Configuring Java CAPS Environment Components for Communications Adapters
There are new versions of the Configuration templates used in version 6. For previous 5.1.x projects that are imported or going through an "in-place upgrade" to the latest version, the Configuration template will be upgraded during design time or build time.
At design time when you open the Connectivity Map or Environment properties window, a warning window appears (as shown in the figure below), and the Configuration template automatically upgrades. You can now update the Environment properties with any necessary change, and run the project.
If you attempt to build a project without first opening either the Connectivity Map or Environment property window, code generation will automatically upgrade the Configuration template. Once this build-time upgrade scenario is complete, you will not see the warning window anymore.