Using the External Service Registry to Configure ESB Hosts

Using the External Service Registry to Configure ESB Hosts

If the ESB production and the External Service Registry are in the same namespace, you can use the registry to configure ESB hosts. This allows you to centralize the information about external services in the registry. In most cases, you can use this to set the properties of the business operations that are accessing the external services, but you can also use it for business services, such as services based on the FTP incoming adapter that retrieve the incoming message from an FTP server.

You can use the External Service Registry to set the properties for hosts that implement any of the following adapters:

• EnsLib.FTP.InboundAdapter

• EnsLib.FTP.OutboundAdapter

• EnsLib.File.InboundAdapter

• EnsLib.File.OutboundAdapter

• EnsLib.HTTP.OutboundAdapter

• EnsLib.SOAP.OutboundAdapter

• EnsLib.SQL.InboundAdapter

• EnsLib.SQL.OutboundAdapter

• EnsLib.TCP.OutboundAdapter

To configure a host to get its settings from the External Service Registry, set the External Registry ID field to the key value of the registry entry. The key value consists of the service Name, Domain, and Version concatenated together with || (two vertical bars) separating the elements. For example, to get the property values from the External Service Registry entry with the name GetDaily, the domain Weather, and Version 1.0, set the External Registry ID property to the following:

GetDaily||Weather||1.0

The following describes how the Endpoint value is used to set the adapter properties for each protocol:

• HTTP and REST—The Endpoint sets the HTTPServer, HTTPPort, and URL properties. For example if the Endpoint is:

  http://newsrvcs.example.com:57781/csp/samples/docserver/namespaces

  Then the business operation properties are set as follows:

  HTTPServer: newsrvcs.example.com

  HTTPPort: 57781

  URL: /csp/samples/docserver/namespaces

  If the business operation is a pass-through business operation, then the special characters * (asterisk), ^ (caret), and | (vertical bar) describe how to build the endpoint from the incoming URL. See Configuring Pass-through Business Operations for details.

• FTP—The Endpoint sets the FTPServer, FTPPort, FilePath, and SSLConfig properties. For example, if the Endpoint is:

  ftp://newftp.example.com/filestore/docs/

  Then the business operation properties are set as follows:

  FTPServer: newftp.example.com

  FTPPort: 21

  FilePath: /filestore/docs/

  If the protocol is sftp://, then SSLConfig is set to "!SFTP" and the FTPPort is set to 22.

• SQL—The Endpoint is used to set the DSN property.

• SOAP—The Endpoint is used to set the WebServiceURL property. The EnsLib.SOAP.GenericOperationOpens in a new tab and EnsLib.SOAP.GenericOperationInProcOpens in a new tab pass-through operations are considered HTTP operations, not SOAP operations for this purpose.

• File—The Endpoint is used to set the FilePath property.

• TCP—The Endpoint is used to set the IPAddress and Port properties. For example, if the Endpoint is:

  102.23.10.1:4500

  Then the business operation properties are set as follows:

  IPAddress: 102.23.10.1

  Port: 4500

• HL7 and X12—The beginning of the Endpoint string specifies the underlying protocol: File, TCP, FTP, or HTTP. For File and TCP, the file: and tcp: are removed from the string Endpoint before parsing it.

The business operation settings from the External Service Registry entry override any settings from System Default Settings, production definition, and business host class definition.