Using TCP Adapters with Ensemble - InterSystems Documentation

More documents

Recommendations

Info

Using the TCP Text Line Outbound AdapterDisconnect()Method Disconnect()Disconnect() takes down the connection to the TCP listener.SendMessageStringMethod SendMessageString(pRequestString As %String,Output pResponseString As %String) As %StatusSendMessageString sends the string contents as a text line on the TCP socket.TestConnection()Method TestConnection()TestConnection() corrects the properties reflecting the connection state. If the adapter is connected,TestConnection() returns True. If not, TestConnection() calls Disconnect() and returns False.7.5 Adapter SettingsThis topic describes the settings that are specific to the EnsLib.TCP.TextLineOutboundAdapter associated with the businessoperation. For settings not listed here, see “Business Operation Settings” in the chapter “Configuration” in ManagingEnsemble Productions.CharsetSpecifies the text character set to use to translate characters for the input file. The string is not case-sensitive. Thedefault is Binary. Use Binary for binary files, or for any data in which newline and linefeed characters aredistinct or must remain unchanged, for example in HL7 Version 2 or EDI messages. Other settings may be usefulwhen transferring text documents. Choices include:• Binary — Binary transfer (the default)• Ascii — Ascii mode FTP transfer but no character encoding translation• Default — The default character encoding of the local Ensemble server• Latin1 — The ISO Latin1 8-bit encoding• ISO-8859-1 — The ISO Latin1 8-bit encoding• UTF-8 — The Unicode 8-bit encoding• UCS2 — The Unicode 16-bit encoding• UCS2-BE — The Unicode 16-bit encoding (Big-Endian)• Any other alias from an international character encoding standard for which NLS (National Language Support)is installed in Ensemble.ConnectTimeoutNumber of seconds to wait on each attempt to connect to the remote TCP listener. The default is 5 seconds.48 Using TCP Adapters with Ensemble
Adapter SettingsGetReplyIPAddressLocalInterfacePortQSizeReadTimeoutSSLConfigIf 1 (true) wait to read a reply message back from the socket before returning. If 0 (false) do not wait. The defaultvalue is 1.IP address to make a TCP connection to. The adapter accepts a named IP address, an IPV4 address, or an IPV6address.If the address starts with a ! character, the adapter waits for a connection from a remote system. In this case, followthe exclamation point with a comma-separated list of remote IP addresses from which to accept connections. Theadapter accepts named IP addresses, IPV4 addresses, or IPV6 addresses. An optional :port designation is supported;so, for example, both of the following address formats are acceptable: 192.168.1.22 or 192.168.1.22:3298.If no IP address follows the ! character, any remote system may connect; otherwise only the listed IP addresses(and ports) are allowed to connect.Specifies the network interface through which the TCP connection should go. Select a value from the list or typea value. An empty value means use any interface.This setting allows you to specify that a virtual IP address should be used to send outbound traffic, which is usefulin the case of mirroring. If a remote application is configured to accept traffic from the virtual IP address, and boththe primary and the secondary use that IP address to connect to the remote application, then everything continuesto work when the secondary starts sending.Identifies the TCP port to connect to. TCP port numbers have a maximum value of 65535.How many incoming connections the operating system should hold in reserve on behalf of this business operation.There is generally no reason to change the default value of 0. Either the connection is outbound, or the businessoperation is using '!' inbound mode, in which case only 1 client is allowed at a time, per business operation pooljob.Number of seconds to wait for each successive incoming TCP read operation, following receipt of initial datafrom the remote TCP port. The default is 5 seconds. The range is 0–600 seconds (a maximum of 10 minutes).The name of an existing Secure Socket Layer (SSL) or Transport Layer Security (TLS) configuration to use toauthenticate this connection.You can create and manage SSL/TLS configurations using the Management Portal. See “Using SSL/TLS withCaché” in the Caché Security Administration Guide.The first field on the Edit SSL/TLS Configuration form is Configuration Name. This is the string to use in the adapter’sSSLConfig field. The SSLConfig string may also add a | (vertical bar) character followed by the private keypassword. The | character is unique because it is not allowed as part of a Configuration Name.ReconnectRetryNumber of retries at which to drop the connection and try reconnecting again. A value of 0 (zero) means neverdisconnect. The default value is 5.Using TCP Adapters with Ensemble 49
Page 2:
Using TCP Adapters with EnsembleEns
Page 6 and 7: List of TablesTable 6-1: TCP Status
Page 9 and 10: 1Choosing a TCP AdapterThis chapter
Page 11 and 12: 2Using the TCP Counted Inbound Adap
Page 13 and 14: Using the AdapterAn Ensemble produc
Page 15 and 16: Sample Business Service Class Code4
Page 17: Adapter SettingsEndianA choice of B
Page 20 and 21: Using the TCP Counted Outbound Adap
Page 28 and 29: Using the TCP Counted XML Inbound A
Page 34 and 35: Using the TCP Counted XML Outbound
Page 42 and 43: Using the TCP Text Line Inbound Ada
Page 50 and 51: Using the TCP Text Line Outbound Ad
Page 58 and 59: Creating Custom TCP Adapter Classes
Page 60 and 61: Creating Custom TCP Adapter Classes
Page 62 and 63: Settings for the Abstract TCP Adapt
Page 65 and 66: BCommon Tasks in the Management Por
show all

Using TCP Adapters with Ensemble - InterSystems Documentation

Create successful ePaper yourself

Delete template?

Save as template?