1. Using Oracle SOA Suite for Healthcare Integration
  2. Creating Endpoints with Different Transport Protocols

B Creating Endpoints with Different Transport Protocols

The appendix covers how to create endpoints with different bidirectional and single-directional transport protocols.

The appendix contains the following topics:

B.1 Creating Bidirectional Endpoints

The supported bidirectional protocols are MLLP 1.0, MLLP 2.0, Generic TCP, and HLLP.

B.1.1 Creating an MLLP 1.0 Endpoint

This section covers how to create a bidirectional endpoint with the MLLP 1.0 transport protocol.

To create an endpoint with the MLLP 1.0 transport protocol:

  1. Log on to the Oracle SOA Suite for healthcare integration user interface.
  2. In the Configuration tab under the Design tab, click the Endpoint folder and then click the Create button as shown in Figure B-1.

    Figure B-1 Create Endpoint Button

    Description of Figure B-1 follows
    Description of "Figure B-1 Create Endpoint Button"
  3. In the Create window, enter the following and click OK, as shown in Figure B-2:

    • Name: Name of the endpoint.

    • Transport Protocol: Transport protocol for the sending or receiving messages. In this case, select MLLP10.

    • Connection Mode: Server or Client. If the endpoint is configured as server, Oracle SOA Suite for healthcare integration engine starts listening on a port and waits for a client to connect to it. In general, the server connection mode is for inbound case. When configured as client, the engine connects to the hostname and port of a remote computer or device. In general, this is for an outbound case.

    • Host Name: In case of an MLLP 1.0 Server endpoint, it should be name or IP address of the computer hosting Oracle SOA Suite, and in the case of an MLLP Client endpoint, it should be the remote host name or device name. Typically, this should be localhost. However, Host name can also be the name of the remote host or device.

    • Port: port number should be more than 500. If the connection mode is set to Server, then the port must be a valid TCP port number. If the connection mode is set to Client, then the port must be the same as the port used on the MLLP server.

    This creates the endpoint, and the endpoint is displayed in the right panel of the Oracle SOA Suite for healthcare integration user interface.

    Figure B-2 Specifying MLLP 1.0 Endpoint Parameters

    Description of Figure B-2 follows
    Description of "Figure B-2 Specifying MLLP 1.0 Endpoint Parameters"

B.1.2 Creating an MLLP 2.0 Endpoint

This section covers how to create a bidirectional endpoint with the MLLP 2.0 transport protocol.

To create an endpoint with the MLLP 2.0 transport protocol:

  1. Repeat Steps 1 and 2 from Creating an MLLP 1.0 Endpoint.
  2. In the Create window, enter the following and click OK, as shown in Figure B-3:

    • Name: Name of the endpoint.

    • Transport Protocol: Transport protocol for the sending or receiving messages. In this case, select MLLP20.

    • Connection Mode: Server or Client. If the endpoint is configured as server, Oracle SOA Suite for healthcare integration engine starts listening on a port and waits for a client to connect to it. In general, the server connection mode is for inbound case. When configured as client, the engine connects to hostname and port of a remote computer or device. In general, this is for an outbound case.

    • Host Name: In case of an MLLP 2.0 Server endpoint, it should be name or IP address of the computer hosting Oracle SOA Suite, and in the case of an MLLP 2.0 Client endpoint, it should be the remote host name or device name. Typically, this should be localhost. However, Host name can also be the name of the remote host or device.

    • Port: A valid TCP port number ranging between 1 and 999999.

    This creates the endpoint, and the endpoint is displayed in the right panel of the Oracle SOA Suite for healthcare integration user interface.

    Figure B-3 Specifying MLLP 2.0 Endpoint Parameters

    Description of Figure B-3 follows
    Description of "Figure B-3 Specifying MLLP 2.0 Endpoint Parameters"

    Note:

    On the endpoint page, ensure that:

    • The Acknowledgement Mode is set to Sync for MLLP 2.0. For a Single-Byte Acknowledgment, set the Mode to None.

    • In the Transport Protocol Parameters dialog box (displays when you click the Transport Details button), the Permanent Connection check box is selected in the Connection tab.

      Note:

      The default idle time for a permanent connection is 24 hours. If there is no activity for 24 hours, the connection closes, even though it is permanent.

    The reason is that MLLP 2.0 is not supported for Transient connection and for Asynchronous ACK.

B.1.3 Creating a Generic TCP Endpoint

This section covers how to create a bidirectional endpoint with the Generic TCP transport protocol.

To create an endpoint with the Generic TCP transport protocol:

  1. Repeat Steps 1 and 2 from Creating an MLLP 1.0 Endpoint.
  2. In the Create window, enter the following and click OK, as shown in Figure B-4:

    • Name: Name of the endpoint.

    • Transport Protocol: Transport protocol for the sending or receiving messages. In this case, select GENERIC TCP.

    • Connection Mode: Server or Client. If the endpoint is configured as server, Oracle SOA Suite for healthcare integration engine starts listening on a port and waits for a client to connect to it. In general, the server connection mode is for inbound case. When configured as client, the engine connects to hostname and port of a remote computer or device. In general, this is for an outbound case.

    • Host Name: In case of an Generic TCP Server endpoint, it should be name or IP address of the computer hosting Oracle SOA Suite, and in the case of an Generic TCP Client endpoint, it should be the remote host name or device name. Typically, this should be localhost. However, Host name can also be the name of the remote host or device.

    • Port: A valid TCP port number ranging between 1 and 999999.

    This creates the endpoint, and the endpoint is displayed in the right panel of the Oracle SOA Suite for healthcare integration user interface.

    Figure B-4 Specifying Generic TCP Endpoint Parameters

    Description of Figure B-4 follows
    Description of "Figure B-4 Specifying Generic TCP Endpoint Parameters"

B.1.4 Creating an HLLP Endpoint

HLLP exchange protocol is a variation of the lower layer protocol. It is advanced form of MLLP Exchange Plug-in. It allows error detection and validation of HL7 messages. This protocol is based on TCP transport protocol. This section covers how to create a bidirectional endpoint with the HLLP protocol.

To create an endpoint with the HLLP protocol:

  1. Repeat Steps 1 and 2 from Creating an MLLP 1.0 Endpoint.
  2. In the Create window, enter the following and click OK, as shown in Figure B-5:

    • Name: Name of the endpoint.

    • Transport Protocol: Transport protocol for the sending or receiving messages. In this case, select HLLP.

    • Connection Mode: Server or Client. If the endpoint is configured as server, Oracle SOA Suite for healthcare integration engine starts listening on a port and waits for a client to connect to it. In general, the server connection mode is for inbound case. When configured as client, the engine connects to hostname and port of a remote computer or device. In general, this is for an outbound case.

    • Host Name: In case of an HLLP Server endpoint, it should be name or IP address of the computer hosting Oracle SOA Suite, and in the case of an HLLP Client endpoint, it should be the remote host name or device name. Typically, this should be localhost. However, Host name can also be the name of the remote host or device.

    • Port: A valid HLLP port number ranging between 1024 and 65535.

    Note:

    You must enable sequencing in the case of HLLP endpoints.

    This creates the endpoint, and the endpoint is displayed in the right panel of the Oracle SOA Suite for healthcare integration user interface as shown in Figure B-6.

    Note:

    In HLLP Client Connection Mode, the Acknowledgement Mode dropdown list can only be set to None.

    Figure B-5 Specifying HLLP Endpoint Parameters

    Description of Figure B-5 follows
    Description of "Figure B-5 Specifying HLLP Endpoint Parameters"

    Figure B-6 The Endpoints Page

    Description of Figure B-6 follows
    Description of "Figure B-6 The Endpoints Page"

B.2 Creating Single-Directional Endpoints

The supported single-directional protocols are File, FTP, JMS, and SFTP.

B.2.1 Creating a File Endpoint

This section covers how to create a single-directional endpoint with the File transport protocol.

The File transport enables files to be picked up from a shared file directory.

To create an endpoint with the FILE protocol:

  1. Repeat Steps 1 and 2 from Creating an MLLP 1.0 Endpoint.
  2. In the Create window, enter the following and click OK, as shown in Figure B-7:

    • Name: Name of the endpoint.

    • Transport Protocol: Transport protocol for the sending or receiving messages. In this case, select FILE.

    • Direction: Inbound or Outbound based on your requirement. If the endpoint is configured as inbound, then it can receive response messages or FAs from other endpoints. Conversely, if the endpoint is configured as outbound, it can send messages or FAs.

    • Folder Name: An absolute directory path is recommended. Inbound messages are expected in this folder and outbound messages or FAs must be delivered here.

    This creates the endpoint, and the endpoint is displayed in the right panel of the Oracle SOA Suite for healthcare integration user interface.

    Figure B-7 Specifying File Endpoint Parameters

    Description of Figure B-7 follows
    Description of "Figure B-7 Specifying File Endpoint Parameters"

    Note:

    After a single-directional transport endpoint (inbound/outbound) is created, then it can be edited later to add inbound or outbound configuration by clicking the Configure link.

B.2.2 Creating an FTP Endpoint

This section covers how to create a single-directional endpoint with the FTP transport protocol.

FTP enables files to be passed with FTP between applications. FTP runs on default port 21.

To create an endpoint with the FTP protocol:

  1. Repeat Steps 1 and 2 from Creating an MLLP 1.0 Endpoint.
  2. In the Create window, enter the following and click OK, as shown in Figure B-8.

    • Name: Name of the endpoint.

    • Transport Protocol: Transport protocol for the sending or receiving messages. In this case, select FTP.

    • Direction: Inbound or Outbound based on your requirement. If the endpoint is configured as inbound, then it can receive response messages or FAs from other endpoints. Conversely, if the endpoint is configured as outbound, it can send messages or FAs.

    • Host name: The name of the host computer.

    • Folder Name: An absolute directory path is recommended. Inbound messages are expected in this folder and outbound messages or FAs must be delivered here.

    • User name: The user name (login name) to connect to the target server.

    This creates the endpoint, and the endpoint is displayed in the right panel of the Oracle SOA Suite for healthcare integration user interface.

    Figure B-8 Specifying FTP Endpoint Parameters

    Description of Figure B-8 follows
    Description of "Figure B-8 Specifying FTP Endpoint Parameters"

B.2.3 Creating an JMS Endpoint

This section covers how to create a single-directional endpoint with the JMS transport protocol.

JMS enables applications to send and receive messages to and from the queues and topics administered by any Java Message Service (JMS) provider, including Oracle WebLogic JMS and non-Oracle providers such as MQSeries JMS (IBM). If a user name and password are not provided, the local JNDI is used, including in a clustered environment, provided that the destinations are distributed.

To create an endpoint with the JMS protocol:

  1. Repeat Steps 1 and 2 from Creating an MLLP 1.0 Endpoint.
  2. In the Create window, enter the following and click OK, as shown in Figure B-9.

    • Name: Name of the endpoint.

    • Transport Protocol: Transport protocol for the sending or receiving messages. In this case, select JMS.

    • Direction: Inbound or Outbound based on your requirement. If the endpoint is configured as inbound, then it can receive response messages or FAs from other endpoints. Conversely, if the endpoint is configured as outbound, it can send messages or FAs.

    • Destination name: The JNDI name of the JMS queue or topic.

    • Connection factory: The JNDI name of the connection factory such as jms/b2b/B2BQueueConnectionFactory.

This creates the endpoint, and the endpoint is displayed in the right panel of the Oracle SOA Suite for healthcare integration user interface.

Figure B-9 Specifying JMS Endpoint Parameters

Description of Figure B-9 follows
Description of "Figure B-9 Specifying JMS Endpoint Parameters"
B.2.3.1 Retrieving Document Information from JMS Headers

Oracle Healthcare supports retrieving of document information such as DOC_TYPE and DOC_REVISION from JMS headers in the following order:

  • If these values are found in JMS headers, then Oracle Healthcare uses these values to identify a document.

  • If these values are not found in JMS headers, then Oracle Healthcare uses the payload to identify these values.

Note:

The default MSG_TYPE in the case of JMS endpoints are considered as Request. In addition, you can identify the 997 or Acknowledgement messages from DOC_TYPE. So, if you want to pass messages with type other than 997, Acknowledgement, or Request, you must explicitly pass MSG_TYPE as part of JMS headers.

B.2.4 Creating an SFTP Endpoint

This section covers how to create a single-directional endpoint with the SFTP transport protocol.

SFTP enables files to be passed using SSH FTP. SFTP runs on default port 22, which can be changed to another port.

To create an endpoint with the SFTP protocol:

  1. Repeat Steps 1 and 2 from Creating an MLLP 1.0 Endpoint.
  2. In the Create window, enter the following and click OK, as shown in Figure B-10.

    • Name: Name of the endpoint.

    • Transport Protocol: Transport protocol for the sending or receiving messages. In this case, select SFTP.

    • Direction: Inbound or Outbound based on your requirement. If the endpoint is configured as inbound, then it can receive response messages or FAs from other endpoints. Conversely, if the endpoint is configured as outbound, it can send messages or FAs.

    • Host name: The name of the host computer.

    • Port number: A valid SFTP port number within the range of 1 to 999999. The default value is 22.

    • Path: The absolute directory path where messages are sent from or received.

    • User name: The user name (login name) to connect to the target server.

    This creates the endpoint, and the endpoint is displayed in the right panel of the Oracle SOA Suite for healthcare integration user interface.

    Figure B-10 Specifying SFTP Endpoint Parameters

    Description of Figure B-10 follows
    Description of "Figure B-10 Specifying SFTP Endpoint Parameters"