Configuring Java CAPS Environment Components for Communications Adapters

Transcription

1 Configuring Java CAPS Environment Components for Communications Adapters Sun Microsystems, Inc Network Circle Santa Clara, CA U.S.A. Part No: June 2008

2 Copyright 2008 Sun Microsystems, Inc Network Circle, Santa Clara, CA U.S.A. All rights reserved. Sun Microsystems, Inc. has intellectual property rights relating to technology embodied in the product that is described in this document. In particular, and without limitation, these intellectual property rights may include one or more U.S. patents or pending patent applications in the U.S. and in other countries. U.S. Government Rights Commercial software. Government users are subject to the Sun Microsystems, Inc. standard license agreement and applicable provisions of the FAR and its supplements. This distribution may include materials developed by third parties. Parts of the product may be derived from Berkeley BSD systems, licensed from the University of California. UNIX is a registered trademark in the U.S. and other countries, exclusively licensed through X/Open Company, Ltd. Sun, Sun Microsystems, the Sun logo, the Solaris logo, the Java Coffee Cup logo, docs.sun.com, Java, and Solaris are trademarks or registered trademarks of Sun Microsystems, Inc. or its subsidiaries in the U.S. and other countries. All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. in the U.S. and other countries. Products bearing SPARC trademarks are based upon an architecture developed by Sun Microsystems, Inc. The OPEN LOOK and Sun TM Graphical User Interface was developed by Sun Microsystems, Inc. for its users and licensees. Sun acknowledges the pioneering efforts of Xerox in researching and developing the concept of visual or graphical user interfaces for the computer industry. Sun holds a non-exclusive license from Xerox to the Xerox Graphical User Interface, which license also covers Sun's licensees who implement OPEN LOOK GUIs and otherwise comply with Sun's written license agreements. Products covered by and information contained in this publication are controlled by U.S. Export Control laws and may be subject to the export or import laws in other countries. Nuclear, missile, chemical or biological weapons or nuclear maritime end uses or end users, whether direct or indirect, are strictly prohibited. Export or reexport to countries subject to U.S. embargo or to entities identified on U.S. export exclusion lists, including, but not limited to, the denied persons and specially designated nationals lists is strictly prohibited. DOCUMENTATION IS PROVIDED AS IS AND ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE DISCLAIMED, EXCEPT TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD TO BE LEGALLY INVALID @21808

3 Contents Configuring Java CAPS Environment Components for Communications Adapters...7 Using the Environment Properties Editor...8 To Configure the Environment Properties...8 Configuring Batch Adapter Batch Inbound Environment Properties...9 MDB Settings (BatchInbound Environment)...9 Configuring TCP/IP Adapter Environment Properties...9 TCPIP Server (Inbound) Adapter - General Inbound Settings...9 TCPIP Server (Inbound) Adapter - TCPIP Inbound Settings TCPIP Server (Inbound) Adapter - MDB Pool Settings TCPIP Client (Outbound) Adapter - General Outbound Settings TCPIP Client (Outbound) Adapter - TCPIP Outbound Settings TCPIP Client (Outbound) Adapter - Connection Pool Settings Configuring TCP/IP HL7 Adapter Environment Explorer Properties HL7 Inbound Adapter - TCPIP Inbound Settings HL7 Inbound Adapter - MDB Pool Settings HL7 Inbound Adapter - Sequence Number Protocol HL7 Outbound Adapter - TCPIP Outbound Settings HL7 Outbound Adapter - Connection Pool Settings HL7 Outbound Adapter - Sequence Number Protocol Configuring Adapter Environment Properties Inbound Adapter Connection Settings Inbound Adapter SSL Inbound Adapter SSL CACerts Inbound Adapter MDB Settings Outbound Adapter Connection Settings Send SMTP Outbound Adapter Connection Settings Receive POP Outbound Adapter SSL Outbound Adapter SSL CACerts

4 Contents Configuring File Adapter Environment Properties Inbound File Adapter - Parameter Settings Inbound File Adapter - MDB Settings Outbound File Adapter - Parameter Settings Configuring MSMQ Adapter Environment Properties Inbound MSMQ Adapter MSMQ Environment Inbound MSMQ Adapter MDB Settings Inbound MSMQ Adapter Connection Retry Settings Outbound MSMQ Adapter MSMQ Environment Outbound MSMQ Adapter Connection Retry Settings Configuring Batch Adapter BatchFTP Environment Properties SOCKS (BatchFTP Environment) FTP (BatchFTP Environment) General Settings (BatchFTP Environment) SSH Tunneling (BatchFTP Environment) Connection Pool Settings (BatchFTP Environment) Connection Retry Settings (BatchFTP Environment) Configuring Batch Adapter BatchFTPOverSSL Environment Properties FTP and SSL Settings (BatchFTPOverSSL Environment) Firewall Settings (BatchFTPOverSSL Environment) General Settings (BatchFTPOverSSL Environment) Connection Pool Settings (BatchFTPOverSSL Environment) Connection Retry Settings (BatchFTPOverSSL Environment) Configuring Batch Adapter BatchSCP Environment Properties SSH Settings (BatchSCP Environment) Firewall Settings (BatchSCP Environment) General Settings (BatchSCP Environment) Connection Pool Settings (BatchSCP Environment) Connection Retry Settings (BatchSCP Environment) Configuring Batch Adapter BatchSFTP Environment Properties SFTP Settings (BatchSFTP Environment) Firewall Settings (BatchSFTP Environment) General Settings (BatchSFTP Environment) Connection Pool Settings (BatchSFTP Environment) Connection Retry Settings (BatchSFTP Environment) Configuring Batch Adapter BatchLocalFile Environment Properties Configuring Java CAPS Environment Components for Communications Adapters June 2008

5 Contents General Settings (BatchLocalFile Environment) Connection Pool Settings (BatchLocalFile Environment) Configuring Batch Adapter BatchRecord Environment Properties Connection Pool Settings (BatchRecord Environment) Configuring CICS Adapter Environment Properties Sun CICS Listener CICS Gateway CICS Client Tracing Connection Retry Settings Connection Pool Settings Configuring COM/DCOM Adapter Environment Properties Configuring HTTPS Adapter Environment Properties Property Categories Configured in the Application Server Environment HTTP Settings Proxy Configuration Security Additional SSL Section Notes Connection Pool Settings Configuring IMS Adapter Environment Properties TCP/IP Configuration IRM Header Serial Mode Settings Connection Retry Settings Connection Pool Settings Configuring LDAP Adapter Properties Configuring Connection Section Properties Configuring the Security/SSL Section Properties Configuring the Connection Retry Settings Configuring the Connection Pool Settings Configuring the SNA Adapter Environment Properties Property Categories Configured in the Application Server Environment

6 6

7 Configuring Java CAPS Environment Components for Communications Adapters The adapter environment configuration properties contain parameters that define how the adapter connects to and interacts with other Java CAPS components within the environment. The environment properties are accessed from the NetBeans IDE Services window. The following sections provide instructions on how to configure Java CAPS component environment properties and lists the environment properties for the various communications adapters. What You Need to Know This topic provides information you should know to start configuring the environment properties UsingtheEnvironmentPropertiesEditor onpage8. What You Need to Do These topics provide configuration information used to set the communications adapter environment properties. Configuring Batch Adapter Batch Inbound Environment Properties on page 9. Configuring TCP/IP Adapter Environment Properties on page 9. Configuring TCP/IP HL7 Adapter Environment Explorer Properties on page 16. Configuring Adapter Environment Properties on page 21. Configuring File Adapter Environment Properties on page 27. Configuring MSMQ Adapter Environment Properties on page 29. Configuring Batch Adapter BatchFTP Environment Properties on page 32. Configuring Batch Adapter BatchFTPOverSSL Environment Properties on page 40. Configuring Batch Adapter BatchSCP Environment Properties on page 45. Configuring Batch Adapter BatchSFTP Environment Properties on page 50. Configuring Batch Adapter BatchLocalFile Environment Properties on page 54. Configuring Batch Adapter BatchRecord Environment Properties on page 56. Configuring CICS Adapter Environment Properties on page 57. Configuring COM/DCOM Adapter Environment Properties on page 64. Configuring HTTPS Adapter Environment Properties on page 64. 7

8 Using the Environment Properties Editor Configuring IMS Adapter Environment Properties on page 72. Configuring LDAP Adapter Properties on page 83. Configuring the SNA Adapter Environment Properties on page 87. Using the Environment Properties Editor The Adapter Environment Configuration properties contain parameters that define how the adapter connects to and interacts with other Java CAPS components within the Environment. The Environment properties are accessed from the NetBeans IDE Services window To Configure the Environment Properties From the NetBeans Services window, expand the CAPS Environment node. Expand the Environment created for your project and locate the External System for your specific adapter. Right-click the External System and select Properties from the popup menu. The Environment Configuration Properties window appears. 4 FIGURE 1 Adapter Environment Configuration Properties Editor From the Properties Editor, click on any folder to display the default configuration properties for that section. 8 Configuring Java CAPS Environment Components for Communications Adapters June 2008

9 ConfiguringTCP/IP Adapter Environment Properties 5 6 Click on any property field to make it editable. Once you have finished modifying the properties, click OK to save your changes and close the editor. Configuring Batch Adapter Batch Inbound Environment Properties This topic explains the configuration parameters for the BatchInbound Adapter (OTD), accessed from the Environment Explorer. MDB Settings (BatchInbound Environment) The MDB Settings section of the BatchInbound Environment properties contains the top-level parameters displayed in the following table. TABLE 1 Connectivity Map - BatchInbound- Settings Max Pool Size Specifies the maximum size of the MDB (Message Driven Bean) pool. An integer indicating the maximum MDB pool size. The configured default is Configuring TCP/IP Adapter Environment Properties The TCP/IP Adapter Environment properties are organized into the following sections: TCPIP Server (Inbound) Adapter - General Inbound Settings on page 9. TCPIP Server (Inbound) Adapter - TCPIP Inbound Settings on page 10. TCPIP Server (Inbound) Adapter - MDB Pool Settings on page 11. TCPIP Client (Outbound) Adapter - General Outbound Settings on page 13. TCPIP Client (Outbound) Adapter - TCPIP Outbound Settings on page 14. TCPIP Client (Outbound) Adapter - Connection Pool Settings on page 14. TCPIP Server (Inbound) Adapter - General Inbound Settings The General Inbound Settings properties represents general TCPIP Inbound configuration information. The TCPIPServer (Inbound) Adapter - General Inbound Settings properties contain the top-level parameters displayed in the following table. Configuring Java CAPS Environment Components for Communications Adapters 9

10 ConfiguringTCP/IP Adapter Environment Properties TABLE 2 TCPIPServer (Inbound) Adapter - General Inbound Settings Properties Persistence State File Location Specifies the directory location (a local folder name) where the state files, used to persist the state value, are stored. This property is required when the Scope Of State is set to Persistence. The file and path. The default value is C:/temp/tcpipinbound/state (depending on the environment settings). TCPIP Server (Inbound) Adapter - TCPIP Inbound Settings Specifies the Java Socket and ServerSocket options. For more information, refer to the JDK Javadoc. The TCPIPServer (Inbound) Adapter - TCPIP Inbound Settings properties contain the top-level parameters displayed in the following table. TABLE 3 TCPIP Server (Inbound) Adapter - MDB Properties Host ServerPort Specifies the host name or IP address used to establish a TCPIP connection. This parameter is only used when Connection Type is Client. Specifies the port number of the TCP/IP destination. This is dependent upon the specified Connection Type. If the value for Connection Type is: Server: the ServerPort value is set to the port number on the local host. Client: the ServerPort value is set to the port number of the external host. A TCP/IP host name or IP address. An integer between 0 and 65535, indicating the port number of the TCP/IP destination. The port number of the TCP/IP destination. The default is Note TCP/IP server connects binds to random port, if the port number is Configuring Java CAPS Environment Components for Communications Adapters June 2008

11 ConfiguringTCP/IP Adapter Environment Properties TABLE 3 TCPIP Server (Inbound) Adapter - MDB Properties (Continued) Backlog Specifies the maximum length of the queue when creating the ServerSocket. The maximum queue length for incoming connection indications (a request to connect) is set to the backlog parameter. If a connection indication arrives when the queue is full, the connection is refused. An integer indicting the queue length for incoming connections. The configured default value is 50. Note This parameter is only used when Connection Type is set to Server. TCPIP Server (Inbound) Adapter - MDB Pool Settings Specific to the MDB bean pool of Sun Java TM System Application Server and Sun Enterprise Service Bus only. The parameter settings in this section are applied to sun-ejb-jar.xml. The TCPIPServer (Inbound) Adapter - MDB Pool Settings properties contain the top-level parameters displayed in the following table. Configuring Java CAPS Environment Components for Communications Adapters 11

12 ConfiguringTCP/IP Adapter Environment Properties TABLE 4 TCPIPServer (Inbound) Adapter - MDB Pool Settings Properties Steady Pool Size Specifies the minimum number of MDB beans to be maintained. When the value is set to a value that is greater than 0, the container not only pre-populates the MDB bean pool with the specified number, but also attempts to ensure that there are always this many MDB beans in the free pool. This ensures that there are enough MDB beans in the ready to serve state to process user requests. This parameter does not guarantee that more than the steady-pool-size MDB instances will not exist at a given time. It only governs the number of instances that are pooled over a long period of time. For example, suppose an idle stateless session container has a fully-populated pool with a steady-pool-size of 10. If 20 concurrent requests arrive for the MDB bean component, the container creates 10 additional instances to satisfy the burst of requests. This prevents the container from blocking any of the incoming requests. However, if the activity dies down to 10 or fewer concurrent requests, the additional 10 instances are discarded. An integer indicating the minimum number of Message Driven Beans (MDBs) to be maintained. The configured default is 10. Max Pool Size Specifies the maximum number of MDB beans in the pool. An integer indicating the maximum number of MDB beans in the pool. A value of 0 means the pool is unbounded. The configured default is Configuring Java CAPS Environment Components for Communications Adapters June 2008

13 ConfiguringTCP/IP Adapter Environment Properties TABLE 4 TCPIPServer (Inbound) Adapter - MDB Pool Settings Properties (Continued) Pool Idle Timeout In Seconds Specifies the interval at which the remove expired MDBs thread runs. This thread periodically removes unused MDB beans with expired timeouts. This provides a hint to the server, and allows the user to specify the maximum amount of time that an MDB bean instance can remain idle in the pool. After this period of time, the pool can remove this bean. When Pool Idle Timeout In Seconds is set to a value greater than 0, the removes or destroys any MDB bean instance that is idle for this specified duration. A value of 0 specifies that idle MDB beans can remain in the pool indefinitely. An integer indicting the Pool Idle Timeout in seconds for unused MDBs. A value of 0 specifies that idle MDBs can remain in the pool indefinitely. The configured default value is 600. TCPIP Client (Outbound) Adapter - General Outbound Settings The General Outbound Settings properties represents general TCPIP outbound configuration information. The TCPIP Client (Outbound) Adapter - General Outbound Settings properties contain the top-level parameters displayed in the following table. TABLE 5 TCPIPClient (Outbound) Adapter - General Outbound Settings Properties Persistence State File Location Specifies the File Location (a local folder name). This property is required when the Scope Of State value is set to is Persistence. This file is used to store the state files which are used to persist the state value. The file and path. The default value is /temp/tcpipoutbound/state. Configuring Java CAPS Environment Components for Communications Adapters 13

14 ConfiguringTCP/IP Adapter Environment Properties TCPIP Client (Outbound) Adapter - TCPIP Outbound Settings The TCPIP Outbound Settings properties represents general TCPIP outbound configuration information. The TCPIP Client (Outbound) Adapter - TCPIP Outbound Settings properties contain the top-level parameters displayed in the following table. TABLE 6 TCPIPClient (Outbound) Adapter - TCPIP Outbound Settings Properties Host Specifies the host name or IP address used to establish a TCPIP connection. This parameter is only used when the Connection Type is set to Client. A TCP/IP host name or IP address. The configured default is localhost. ServerPort Specifies the port number of the TCP/IP destination. This is dependent upon the specified Connection Type. If the value for Connection Type is: Server: The ServerPort value is set to the port The port number of the TCP/IP destination. The default is Backlog number on the local host. Client: The ServerPort value is set to the port number of the external host. Specifies the maximum length of the queue when creating the ServerSocket. The maximum queue length for incoming connection indications (a request to connect) is set to the backlog parameter. If a connection indication arrives when the queue is full, the connection is refused. Note This parameter is only used when Connection Type is set to Server. An integer indicting the queue length for incoming connections. The configured default value is 50. TCPIP Client (Outbound) Adapter - Connection Pool Settings Specific to the RA connection pool of Sun Java System Application Server or the Sun Enterprise Service Bus only. The parameter settings in this section are applied to sun-ra.xml. The TCPIPClient (Outbound) Adapter - Connection Pool Settings properties contain the top-level parameters displayed in the following table. 14 Configuring Java CAPS Environment Components for Communications Adapters June 2008

15 ConfiguringTCP/IP Adapter Environment Properties TABLE 7 TCPIPClient (Outbound) Adapter - Connection Pool Settings Properties Steady Pool Size Specifies the minimum number of RA connections to be maintained. When the value is set to a value that is greater than 0, the container not only pre-populates the RA connection pool with the specified number, but also attempts to ensure that there are always this many RA connections in the free pool. This ensures that there are enough RA connections in the ready to serve state to process user requests. For example, suppose an idle stateless session container has a fully-populated pool with a steady-pool-size of 10. If 20 concurrent requests arrive for the RA Connection component, the container creates 10 additional instances to satisfy the burst of requests. This prevents the container from blocking any of the incoming requests. However, if the activity dies down to 10 or fewer concurrent requests, the additional 10 instances are discarded. An integer indicating the minimum number of RA connections to be maintained. The configured default is 1. Max Pool Size Pool Idle Timeout In Seconds Specifies the maximum number of RA connections in the pool. Specifies the interval at which the remove expired RA connections thread runs. This thread periodically removes unused RA connections with expired timeouts. This provides a hint to the server, and allows you to specify the maximum amount of time that an RA connection instance can remain idle in the pool. After this period of time, the pool can remove this bean. When Pool Idle Timeout In Seconds is set to a value greater than 0, the container removes or destroys any RA connection instance that is idle for this specified duration. A value of 0 specifies that idle RA connections can remain in the pool indefinitely. An integer indicating the maximum number of RA connections in the pool. A value of 0 indicates that the pool is unbounded. The configured default is 32. An integer indicting the Pool Idle Timeout in seconds for unused RA connections. A value of 0 specifies that idle RA connections can remain in the pool indefinitely. The configured default value is 600. Configuring Java CAPS Environment Components for Communications Adapters 15

16 ConfiguringTCP/IP HL7 Adapter Environment Explorer Properties Configuring TCP/IP HL7 Adapter Environment Explorer Properties The TCP/IP HL7 Adapter configuration parameters accessed from the Environment Explorer tree apply to both the inbound and outbound Adapters. The TCP/IP Adapter s Environment properties are organized into the following sections: HL7 Inbound Adapter - TCPIP Inbound Settings on page 16. HL7 Inbound Adapter - MDB Pool Settings on page 17. HL7 Inbound Adapter - Sequence Number Protocol on page 18. HL7 Outbound Adapter - TCPIP Outbound Settings on page 18. HL7 Outbound Adapter - Connection Pool Settings on page 19. HL7 Outbound Adapter - Sequence Number Protocol on page 20. HL7 Inbound Adapter - TCPIP Inbound Settings The HL7 Inbound Adapter - TCPIP Inbound Settings present the java Socket and ServerSocket options. For more information, please refer JDK javadoc. This section of the TCP/IP HL7 Adapter Environment properties contains the top-level parameters displayed in the following table. TABLE 8 Environment - HL7 Inbound Adapter - TCPIP Inbound Settings Host Specifies the host name or IP address used to establish a TCP/IP connection. This parameter is only used when the Connection Type is set to Client. The host name or IP address to used to establish a TCPIP connection. ServerPort Specifies the port number of the TCP/IP destination. This is dependent on the value set for Connection Type, If Connection Type is set to Server, it indicates the port number on the local host. If Connection Type is set to Client, it indicates the port An integer between 0 and 65535, indicating the port number of the TCP/IP destination. The configured default is Backlog number of the external host. Specifies the maximum length of the queue when creating the ServerSocket. The maximum queue length for the incoming connection indications (request to connect) is set to the Backlog parameter. When a connection indication arrives and the queue is full, the connection is refused. This parameter is only used when Connection Type is set to Server. An integer indicating the maximum length of the queue when creating the ServerSocket. The configured default is Configuring Java CAPS Environment Components for Communications Adapters June 2008

17 ConfiguringTCP/IP HL7 Adapter Environment Explorer Properties HL7 Inbound Adapter - MDB Pool Settings The HL7 Inbound Adapter - MDB Pool Settings are specific to the MDB bean pool of Sun Java System Application Server or Sun Runtime Server only. The parameter settings in this section will go into sun-ejb-jar.xml. This section of the TCP/IP HL7 Adapter Environment properties contains the top-level parameters displayed in the following table. TABLE 9 Environment - HL7 Inbound Adapter - TCPIP Inbound Settings Steady Pool Size Specifies the minimum number of MDB beans to be maintained. When the value is set to a number greater than 0 (zero), the container not only pre-populates the MDB bean pool with the specified number, but also attempts to ensure that there is always this many MDB beans in the free pool. This ensures that there are enough MDB beans in the ready-to-serve state to process user requests. This parameter does not necessarily guarantee that no more than steady-pool-size instances exist at a given time. It only governs the number of instances that are pooled over a long period of time. For example, suppose an idle stateless session container has a fully-populated pool with a steady-pool-size of 10. If 20 concurrent requests arrive for the MDB bean component, the container creates 10 additional instances to satisfy the burst of requests. The advantage of this is that it prevents the container from blocking any of the incoming requests. However, if the activity dies down to 10 or fewer concurrent requests, the additional 10 instances are discarded. An integer indication the minimum number of MDB beans to be maintained. The configured default is 10. Max Pool Size Specifies the maximum number of MDB beans in the pool. An integer indication the maximum number of MDB beans in the pool. A value of 0 (zero) indicates that the pool is unbounded. The configured default is 60. Configuring Java CAPS Environment Components for Communications Adapters 17

18 ConfiguringTCP/IP HL7 Adapter Environment Explorer Properties TABLE 9 Environment - HL7 Inbound Adapter - TCPIP Inbound Settings (Continued) Pool Idle Timeout in Seconds Specifies the maximum amount of time (in seconds) that an MDB bean instance can remain idle in the pool. When an MDB has exceeded the configured Pool Idle Timeout, a timer thread removes the unused MDB bean. This property defines the interval at which this thread runs. A value greater than 0 indicates that the container removes or destroys any MDB bean instance that is idle at this specified duration. A value of 0 (zero) specifies that idle MDB beans can remain in the pool indefinitely. The maximum amount of time (in seconds) that an MDB bean instance can remain idle in the pool. The configured default is 600 (10 minutes). HL7 Inbound Adapter - Sequence Number Protocol The HL7 Inbound Adapter - Sequence Number Protocol provides configuration settings used to help prevent duplication of data. This section of the TCP/IP HL7 Adapter Environment properties contains the top-level parameters displayed in the following table. TABLE 10 Environment - HL7 Inbound Adapter - Sequence Number Protocol Sequence Number File Location Specifies the location of the sequence number file (a local directory). This is required when the Sequence Number Protocol is enabled. The sequence number file is a non-volatile directory that stores the sequence number files that are used to persist the HL7 sequence number. This unique base file name is automatically generated according to Project/Collaboration information. For the Inbound Adapter the file names are created as follows: <Project name> + <deployment name> + <external application node name> + <Collaboration name> +.seqno For example: prjhl7inbound_dpin_eahl7inbound_ jcdhl7inbound1.seqno The path and directory where the sequence number file is located. The default setting is: /temp/hl7inbound/seq HL7 Outbound Adapter - TCPIP Outbound Settings Presents the java Socket options. For more information, please refer JDK javadoc. 18 Configuring Java CAPS Environment Components for Communications Adapters June 2008

19 ConfiguringTCP/IP HL7 Adapter Environment Explorer Properties This section of the TCP/IP HL7 Adapter Environment properties contains the top-level parameters displayed in the following table. TABLE 11 Environment - HL7 Outbound Adapter - TCPIP Outbound Settings Host Specifies the host name or IP address used to establish a TCPIP connection. This parameter is only used when the Connection Type is set to Client. The host name or IP address used to establish a TCPIP connection. The configured default is localhost. ServerPort Specifies the port number of the TCP/IP destination. This is dependent on the value set for Connection Type. If Connection Type is set to Server, it indicates the port number on the local host. If Connection Type is set to Client, it indicates the port An integer between 0 and 65535, indicating the port number of the TCP/IP destination. The configured default is number of the external host. Backlog Specifies the maximum length of the queue when creating the ServerSocket. The maximum queue length for the incoming connection indications (request to connect) is set to the Backlog parameter. When a connection indication arrives and the queue is full, the connection is refused. An integer indicating the maximum length of the queue when creating the ServerSocket. The configured default is 50. This parameter is only used when Connection Type is set to Server. HL7 Outbound Adapter - Connection Pool Settings The HL7 Outbound Adapter - Connection Pool Settings are specific to the RA connection pool of Sun Java System Application Server (Sun One Application Server) or Sun Runtime Server only. The parameter settings in this section will go into sun-ra.xml. This section of the TCP/IP HL7 Adapter Environment properties contains the top-level parameters displayed in the following table. Configuring Java CAPS Environment Components for Communications Adapters 19

20 ConfiguringTCP/IP HL7 Adapter Environment Explorer Properties TABLE 12 Environment - HL7 Outbound Adapter - Connection Pool Settings Steady Pool Size Specifies the minimum number of RA connections to be maintained. When the value is set to a number greater than 0 (zero), the container not only pre-populates the RA connection pool with the specified number, but also attempts to ensure that there is always this many RA connections in the free pool. This ensures that there are enough RA connections in the ready-to-serve state to process user requests. This parameter does not necessarily guarantee that no more than steady-pool-size instances exist at a given time. It only governs the number of instances that are pooled over a long period of time. For example, suppose an idle stateless session container has a fully-populated pool with a steady-pool-size of 10. If 20 concurrent requests arrive for the RA connection component, the container creates 10 additional instances to satisfy the burst of requests. The advantage of this is that it prevents the container from blocking any of the incoming requests. However, if the activity dies down to 10 or fewer concurrent requests, the additional 10 instances are discarded. An integer indication the minimum number of RA connections to be maintained. The configured default is 1. Max Pool Size Pool Idle Timeout in Seconds Specifies the maximum number of RA connections in the pool. Specifies the maximum amount of time (in seconds) that an RA connections instance can remain idle in the pool. When an RA connection has exceeded the configured Pool Idle Timeout, a timer thread removes the unused RA connection. This property defines the interval at which this thread runs. A value greater than 0 indicates that the container removes or destroys any RA connection instance that is idle at this specified duration. A value of 0 (zero) specifies that idle RA connections can remain in the pool indefinitely. An integer indication the maximum number of RA connections in the pool. A value of 0 (zero) indicates that the pool is unbounded. The configured default is 32. The maximum amount of time (in seconds) that an RA connections instance can remain idle in the pool. The configured default is 300 (5 minutes). HL7 Outbound Adapter - Sequence Number Protocol The HL7 Outbound Adapter - Sequence Number Protocol provides configuration settings used to help prevent duplication of data. 20 Configuring Java CAPS Environment Components for Communications Adapters June 2008

21 Configuring Adapter Environment Properties This section of the TCP/IP HL7 Adapter Environment properties contains the top-level parameters displayed in the following table. TABLE 13 Environment - HL7 Outbound Adapter - Sequence Number Protocol Sequence Number File Location Specifies the location of the sequence number file (a local directory). This is required when the Sequence Number Protocol is enabled. The sequence number file is a non-volatile directory that stores the sequence number files that are used to persist the HL7 sequence number. This unique base file name is automatically generated according to Project/Collaboration information. For the Outbound Adapter the file names are created as follows: <Project name> + <deployment name> + <collab name> + <externalapplication node name> +.seqno For example: prjhl7outbound_dpout_jcolhl7outbound_ eahl7outbound.seqno The path and directory where the sequence number file is located. The default setting is: /temp/hl7outbound/seq Configuring Adapter Environment Properties The Adapter configuration parameters, accessed from the Adapter External System in the Environment Explorer tree, are organized into the following sections: Inbound Adapter Connection Settings on page 22. Inbound Adapter SSL on page 22. Inbound Adapter SSL CACerts on page 23. Inbound Adapter MDB Settings on page 23. Outbound Adapter Connection Settings Send SMTP on page 24. Outbound Adapter Connection Settings Receive POP3 on page 25. Outbound Adapter SSL on page 26. Outbound Adapter SSL CACerts on page 27. Note Some Adapter properties can also be set from your Collaboration. Properties set from the Collaboration override the corresponding properties in the Adapter s configuration file. Any properties that are not set from the Collaboration retain their configured default settings. Configuring Java CAPS Environment Components for Communications Adapters 21

22 Configuring Adapter Environment Properties Inbound Adapter Connection Settings The Inbound Adapter Connection Settings section of the Adapter Environment properties contains the top-level parameters displayed in the following table. TABLE 14 Environment - Inbound Adapter Connection Settings Host Receive Port Receive User Receive Password Receive Specifies the host name of the server used to receive messages. This is required for receiving Adapter connections. This is also required for sending Adapter connections when the SessionAuth parameter is set to Yes (for POP3 login). Specifies the port number used to connect when receiving messages. This is required for receiving Adapter connections. This is also required for sending Adapter connections when the SessionAuth parameter is set to Yes (for POP3 login). Specifies the user name used when receiving messages. This is required for receiving Adapter connections. This is also required for sending Adapter connections when the SessionAuth parameter is set to Yes (for POP3 login). Specifies the password used when receiving messages. This is required for receiving Adapter connections. This is also required for sending Adapter connections when the SessionAuth parameter is set to Yes (for POP3 login). The host name of the server used to receive messages. The port number used to connect when receiving messages. This is a number between 1 and The configured default is 110. The valid user login name used when receiving messages. The user password used when receiving messages. Inbound Adapter SSL The Inbound Adapter SSL section of the Adapter Environment properties contains the top-level parameters displayed in the following table. 22 Configuring Java CAPS Environment Components for Communications Adapters June 2008

23 Configuring Adapter Environment Properties TABLE 15 Environment - Inbound Adapter SSL Receive SSL Protocol Specifies the SSL protocol to use when establishing an SSL connection with the server. Select the appropriate SSL protocol. The options are: No SSL TLS TLSv1 SSLv3 SSLv2 SSL X509 Algorithm Name Specifies the X509 algorithm name to use for the trust and key manager factories. The configured default is No SSL. An X509 algorithm name. The configured default is SunX509. Inbound Adapter SSL CACerts The Inbound Adapter SSL CACerts section of the Adapter Environment properties contains the top-level parameters displayed in the following table. TABLE 16 Environment - Inbound Adapter SSL CACerts TrustStore type TrustStore TrustStore password Specifies the type of truststore used for CA certificate management when establishing SSL connections. Specifies a truststore used for CA certificate management to establish SSL connections. A truststore file is a key database file that contains the public keys for a target server. Specifies the password for accessing the truststore used for CA certificate management when establishing SSL connections. The truststore type. The configured default is JKS. The truststore used for CA certificate management. The truststore password. Inbound Adapter MDB Settings The Inbound Adapter MDB Settings section of the Adapter Environment properties contains the top-level parameters displayed in the following table. Configuring Java CAPS Environment Components for Communications Adapters 23

24 Configuring Adapter Environment Properties TABLE 17 Environment - Inbound Adapter MDB Settings Max Pool Size Specifies the maximum pool size. This controls the number of concurrent sessions. An integer indicating the maximum pool size. The configured default is 10. Outbound Adapter Connection Settings Send SMTP The Outbound Adapter Connection Settings Send SMTP section of the Adapter Environment properties contains the top-level parameters displayed in the following table. TABLE 18 Environment - Outbound Adapter Connection Settings Send SMTP Host Send Port Send User Send Password Send Text encoding Specifies the host name of the server used to send messages. This is required for the sending Adapter connection. Specifies the port number to connect to when sending messages. This is required for sending Adapter connections. Specifies the user name used when sending messages. This is required for sending Adapter connections. Specifies the password used when sending messages. This is required for sending Adapter connections. Specifies the encoding used for body and header text. Available encoding options are: ASCII: for ASCII text. iso : Latin 1 (Western Europe) text. iso-2022-jp: Japanese character text. ISO2022CN: Chinese character text. ISO2022CN_GB: Simplified Chinese character text. ISO2022KR: Korean character text. The host name of the server used to send messages. An integer indicating the port number. The configured default is 25. The login name used to access the sending host server. The user password used to access the sending host server. Select one of the following: ASCII iso iso-2022-jp ISO2022CN ISO2022CN_GB ISO2022KR 24 Configuring Java CAPS Environment Components for Communications Adapters June 2008

25 Configuring Adapter Environment Properties TABLE 18 Environment - Outbound Adapter Connection Settings Send SMTP (Continued) Header encoding Specifies the encoding used for the header. Available encoding options are: B: Identical to the "BASE64" encoding defined by RFC Q: Designed to allow text containing mostly ASCII characters to be deciphered by an ASCII terminal without decoding. Q encoding is similar to "Quoted-Printable" content- transfer-encoding defined in RFC Q encoding is recommended for use with most Latin character sets, while B encoding is recommended for all others. Select one of the following: B Q Outbound Adapter Connection Settings Receive POP3 The Outbound Adapter Connection Settings Receive POP3 section of the Adapter Environment properties contains the top-level parameters displayed in the following table. TABLE 19 Environment - Outbound Adapter Connection Settings Receive POP3 Host Receive Port Receive Specifies the host name of the server used to receive messages. This is required for receiving Adapter connections. This is also required for sending Adapter connections when the SessionAuth parameter is set to Yes (for POP3 login). Specifies the port number to connect to when receiving messages. This is required for receiving Adapter connections. This is also required for sending Adapter connection when the Session Authentication parameter is set to Yes (for POP3 login). The host name of the server used to receive messages. An integer indicating the port number used to connect with the receiving host server. The configured default is 110. User Receive Specifies the user name used when receiving messages. This is required for receiving Adapter connections. This is also required for sending Adapter connections when the Session Authentication parameter is set to Yes (for POP3 login). The login name used to access the receiving host server. Configuring Java CAPS Environment Components for Communications Adapters 25

26 Configuring Adapter Environment Properties TABLE 19 Environment - Outbound Adapter Connection Settings Receive POP3 (Continued) Password Receive Specifies the password used when receiving messages. This is required for receiving Adapter connections. This is also required for sending Adapter connections when the Session Authentication parameter is set to Yes (for POP3 login). The user password used to access the receiving host server. Session Authentication Determines whether a POP3 session authentication is performed before attempting an SMTP connection. This is required by some services. Set the value to Yes only when necessary. Yes requires that settings for Host Receive, Port Receive, User Receive, and Password Receive are entered for sending the Adapter connection. Select Yes or No. Yes indicates that POP3 session authentication will be performed before attempting an SMTP connection. The configured default is No. Outbound Adapter SSL The Outbound Adapter SSL section of the Adapter Environment properties contains the top-level parameters displayed in the following table. TABLE 20 Environment - Outbound Adapter SSL Send SSL Protocol Specifies the SSL protocol to use when establishing an SSL connection with the SMTP server. Select the appropriate SSL protocol. The options are: No SSL TLS TLSv1 SSLv3 SSLv2 SSL The configured default is No SSL. 26 Configuring Java CAPS Environment Components for Communications Adapters June 2008

27 Configuring File Adapter Environment Properties TABLE 20 Environment - Outbound Adapter SSL (Continued) Receive SSL Protocol Specifies the SSL protocol to use when establishing an SSL connection with the server. Select the appropriate SSL protocol. The options are: No SSL TLS TLSv1 SSLv3 SSLv2 SSL X509 Algorithm Name Specifies the X509 algorithm name to use for the trust and key manager factories. The configured default is No SSL. An X509 algorithm name. The configured default is SunX509. Outbound Adapter SSL CACerts The Outbound Adapter SSL CACerts section of the Adapter Environment properties contains the top-level parameters displayed in the following table. TABLE 21 Environment - Outbound Adapter SSL CACerts TrustStore type TrustStore TrustStore password Specifies the type of truststore used for CA certificate management when establishing SSL connections. Specifies a truststore used for CA certificate management to establish SSL connections. Specifies the password used to access the truststore used for CA certificate management when establishing SSL connections. The truststore type. The configured default is JKS. The truststore used for CA certificate management. The truststore password. Configuring File Adapter Environment Properties The File Adapter configuration parameters, accessed from the Environment Explorer, are organized into the following sections: Inbound File Adapter - Parameter Settings on page 28. Inbound File Adapter - MDB Settings on page 28. Outbound File Adapter - Parameter Settings on page 28. Configuring Java CAPS Environment Components for Communications Adapters 27

28 Configuring File Adapter Environment Properties Inbound File Adapter - Parameter Settings The Inbound File Adapter - Parameter Settings section of the File Adapter Environment properties contains the top level parameters displayed in the following table. TABLE 22 File Adapter Environment Properties - Inbound File Adapter - Parameter Settings Directory Specifies the folder or directory that the Adapter polls for input files. A folder or directory name. You must use the absolute path; specify paths using the (forward) / slash mark. The configured default is C:/temp. Inbound File Adapter - MDB Settings The Inbound File Adapter - MDB Settings section of the File Adapter Environment properties contains the top level parameters displayed in the following table. TABLE 23 File Adapter Environment Properties - Inbound File Adapter - MDB Settings Max Pool Size Specifies the maximum number of Message Driven Beans instantiated at any one point for message handling. The polling interval and the MDB pool size (Max Pool Size) can be tuned based on the expected volume and frequency of incoming messages. A more frequent polling interval, due to a large number of new messages, will trigger the creation of new threads. The number of threads that can be processed, however, is limited by the MDB pool size. When the maximum MDB pool limit is reached, incoming threads are blocked. Increasing the MDB pool size allows more resource adapter threads to send data to the Collaboration. In most cases, the default MDB pool size of 1000 is sufficient. An integer indicating the maximum MDB pool size. The default configuration is Outbound File Adapter - Parameter Settings The Outbound File Adapter - Parameter Settings section of the File Adapter Environment properties contains the top level parameters displayed in the following table. 28 Configuring Java CAPS Environment Components for Communications Adapters June 2008

29 Configuring MSMQ Adapter Environment Properties TABLE 24 File Adapter Environment Properties - Outbound File Adapter - Parameter Settings Directory Specifies the directory to which output files are written. The absolute path and directory name. Configuring MSMQ Adapter Environment Properties The MSMQ Adapter Environment properties are organized into the following sections: Inbound MSMQ Adapter MSMQ Environment on page 29. Inbound MSMQ Adapter MDB Settings on page 29. Inbound MSMQ Adapter Connection Retry Settings on page 30. Outbound MSMQ Adapter MSMQ Environment on page 30. Outbound MSMQ Adapter Connection Retry Settings on page 31. Inbound MSMQ Adapter MSMQ Environment The Inbound MSMQ Adapter MSMQ Environment section of the MSMQ Adapter Environment properties contains the top-level properties displayed in the following table. TABLE 25 Environment - Inbound MSMQ Adapter MSMQ Environment MSMQ Host Name Specifies the Microsoft Message Queue host name. The Microsoft Message Queue host name. Avoid using an IP address or localhost for the local server. These may not work in your MSMQ Environment. Note If the Host Name contains more than 15 characters, MSMQ will truncate the name. In this case, you must use the truncated Host Name. Refer to the Queue Properties, General tab to see the specific Host Name for your system. Inbound MSMQ Adapter MDB Settings The Inbound MSMQ Adapter MDB Settings section of the MSMQ Adapter Environment properties contains the top-level properties displayed in the following table. Configuring Java CAPS Environment Components for Communications Adapters 29

30 Configuring MSMQ Adapter Environment Properties TABLE 26 Environment - Inbound MSMQ Adapter MDB Settings Max Pool Size Specifies the maximum number of physical connections the pool can contain. A value of 0 (zero) indicates that there is no maximum. An integer indicating the maximum pool size. The configured default is Inbound MSMQ Adapter Connection Retry Settings The Inbound MSMQ Adapter Connection Retry Settings section of the MSMQ Adapter Environment properties contains the top-level properties displayed in the following table. TABLE 27 Environment - Inbound MSMQ Adapter Connection Retry Settings Connec tion Retry Count Connec tion Retry Interval Specifies the maximum number of attempts made to connect to the destination queue manager or queue. If the queue manager or queue cannot be accessed for any reason, this setting specifies how many reattempts are made to complete the processing. Specifies the amount of time (in milliseconds) between attempts to connect to the destination queue manager or queue. This is the pause between each reattempt to access the destination queue manager or queue. Used in conjunction with the Connection Retry Count setting. An integer indicating the maximum number of connection attempts. The configured default is 0. An integer indicating the wait time in milliseconds between connection attempts. The configured default is Outbound MSMQ Adapter MSMQ Environment The Outbound MSMQ Adapter MSMQ Environment section of the MSMQ Adapter Environment properties contains the top-level properties displayed in the following table. 30 Configuring Java CAPS Environment Components for Communications Adapters June 2008