Using TCP Adapters with Ensemble - InterSystems Documentation

More documents

Recommendations

Info

Using the TCP Counted XML Inbound Adapter• 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.EndianA choice of Big or Little indicates the byte order of the 4-byte block count prefix. Big endian means the mostsignificant byte (MSB) goes over the wire first; Little endian means the least significant byte (LSB) goes overthe wire first. The default value for this string is Big.JobPerConnectionLocalInterfacePortQSizeWhen True, the adapter spawns a new job to handle each incoming TCP connection and allows simultaneoushandling of multiple connections. When False, it does not spawn a new job for each connection; False is usuallythe appropriate choice for HL7 or X12 connections. The default is True.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.TCP Port to connect to.How many incoming connections the operating system should hold in reserve on behalf of this business service.Set to 0 if only 1 connection at a time is expected. Set to a large number if many clients will connecting rapidly.The default is 100. The range is 0–1000.StayConnectedReadTimeoutSSLConfigIf StayConnected is a positive value, the adapter stays connected to the remote system for this number of secondsbetween input events. A zero value means to disconnect immediately after every input event. The default of –1means to stay permanently connected, even during idle times. Adapters are assumed idle at startup and thereforeonly auto-connect if they are configured with a StayConnected value of –1.Number of seconds to wait for each successive incoming TCP read, following receipt of initial data from remoteTCP port. The default value is 5. The range is from 0 to 600.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 the “Using SSL/TLS withCaché” chapter 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.26 Using TCP Adapters with Ensemble
5Using the TCP Counted XML OutboundAdapterEnsLib.TCP.CountedXMLOutboundAdapter is a TCP adapter that sends XML exported objects out as a counted block ofbytes over a TCP connection and imports a response object. The adapter makes no decisions about the data it relays out tothe external system. It simply maps the request from the business operation to a format that is acceptable to the externalsystem.This chapter explains how to use the EnsLib.TCP.CountedXMLOutboundAdapter. It discusses the following topics:• Background Information• Using the Adapter• Creating a New Business Operation Class• Available Helper Methods• Adapter Settings5.1 Background InformationYou can simply set up the EnsLib.TCP.CountedXMLOutboundAdapter as instructed in the next section, “Using the Adapter.”However, some developers want more details about how a business operation communicates with its configured adapter.This section provides those details.Using TCP Adapters with Ensemble 27
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 30 and 31: 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

Using TCP Adapters with Ensemble - InterSystems Documentation

Create successful ePaper yourself

Delete template?

Save as template?