Using TCP Adapters with Ensemble - InterSystems Documentation

More documents

Recommendations

Info

Using the TCP Counted XML Inbound Adapter• Choose EnsLib.TCP.CountedXMLInboundAdapter from the drop-down list of adapter classes.• Click Finish.The result is a template class like the following:Class Dev.Test.NewService1Extends Ens.BusinessService [ ProcedureBlock ]{Parameter ADAPTER = "EnsLib.TCP.CountedXMLInboundAdapter";Method OnProcessInput(pInput As %RegisteredObject,pOutput As %RegisteredObject) As %Status{Quit $$$ERROR($$$NotImplemented)}}2. Implement the OnProcessInput() method in your new business service class. This is the method that uses the inputdata gathered by the EnsLib.TCP.CountedXMLInboundAdapter.You can implement the OnProcessInput() method by replacing the following line in the template class with your owncode:Quit $$$ERROR($$$NotImplemented)Your OnProcessInput() method must know the types of incoming and outgoing data for communicating with theEnsLib.TCP.CountedXMLInboundAdapter. However, the New Business Service Wizard specifies both types in theOnProcessInput() method signature as the generic object type %RegisteredObject.InterSystems suggests that, as your first action in coding the new business service, you change each OnProcessInput()argument to its specific type passed from the adapter:Method OnProcessInput(pInput As %RegisteredObject,Output pOutput As %RegisteredObject) As %StatusWhere:• pInput is of type %RegisteredObject and can be any of the objects specified by the AcceptClassNames adaptersetting.For details about AcceptClassNames, see “Adapter Settings.”• pOutput is of type %RegisteredObject and contains any response that you might need to return to the XTE server.Keep in mind that the method must quit by returning a %Status object.3. Optionally, you may implement the OnConnect() callback method in your business service class.OnConnect() is available for a TCP inbound adapter to call back to its associated business service. If present in thebusiness service, this method is called each time the TCP inbound adapter establishes a new connection to or from aremote system.If you add an OnConnect() method to your business service class, it must have the following signature:Method OnConnect(pTimeout As %Numeric) As %StatusImplement an OnConnect() method in your business service if you need to take some action each time a new connectionis established, for example to send a logon sequence or a handshake token. The timeout argument is automaticallyprovided by the TCP inbound adapter. It takes its value from the ReadTimeout adapter setting.For details about ReadTimeout, see “Adapter Settings.”Returning an error status from OnConnect() causes the new connection to fail and be disconnected. If an untrappedexception occurs within OnConnect(), the adapter catches it and continues as if OnConnect() were not implemented.4. Compile your new business service class. Compiling also saves it.24 Using TCP Adapters with Ensemble
Adapter Settings5. After creating and compiling the business service class in Studio, add an instance of the business service to the productionand configure it using the Management Portal. See the appendix “Common Tasks in the Management Portal.”When you configure the adapter, you specify a value for the AllowedIPAddresses settings, along other settings. Notethat AllowedIPAddresses provides a way to enable the adapter to initiate the connection; see “Adapter Settings.”4.4 Adapter SettingsThis topic describes the settings that are specific to the EnsLib.TCP.CountedXMLInboundAdapter associated with the businessservice. For settings not listed here, see “Business Service Settings” in the chapter “Configuration” in ManagingEnsemble Productions.AcceptClassnamesComma-separated list, giving the names of classes that this adapter will instantiate from XML blocks received.AllowedIPAddressesCallIntervalCharsetA comma-separated list of remote IP addresses from which to accept connections. The adapter accepts named IPaddresses, IPV4 addresses, or IPV6 addresses. An optional :port designation is supported; so, for example, bothof the following address formats are acceptable: 192.168.1.22 or 192.168.1.22:3298.If the string starts with a !, the adapter will initiate a connection to the specified address. In this case only oneaddress may be given. If a port is included, it will supersede the value of the Port setting; otherwise the Port settingwill be used to connect to the remote system.Number of seconds that the adapter will listen for incoming data from its configured source, before checking fora shutdown signal from the Ensemble framework.If the adapter finds input, it acquires the data and passes it to the business service. The business service processesthe data, and then the adapter immediately begins waiting for new input. This cycle continues whenever the productionis running and the business service is enabled and scheduled to be active.The default CallInterval is 5 seconds. The minimum is 0.1 seconds.Specifies 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 encodingUsing TCP Adapters with Ensemble 25
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 32 and 33: 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?