Skip Headers
Oracle® Fusion Middleware Healthcare Integration User's Guide for Oracle SOA Suite
11g Release 1 (11.1.1.6.0)

Part Number E23486-02
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Index
Index
Go to Master Index
Master Index
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
PDF · Mobi · ePub

4 Working with Endpoints

This chapter describes the concept of an endpoint in Oracle SOA Suite for healthcare integration, and provides instructions for creating and configuring endpoints for healthcare integration applications.

This chapter contains the following topics:

4.1 Introduction to Endpoints

In Oracle SOA Suite for healthcare integration, endpoints are communication channels from where predefined documents are sent or received. Endpoints define how documents are exchanged with an external system, specifying the location, transport protocol, documents to be exchanged, and other configuration parameters. An endpoint can be a URL, folders, or path, among others. Based on the direction of the message, an endpoint can be inbound, outbound, or both. For example, when Oracle SOA Suite for healthcare integration reads from a directory, the directory is the inbound endpoint. Conversely, when Oracle SOA Suite for healthcare integration writes to or sends messages to a directory, the directory is the outbound endpoint. Also, an MLLP endpoint can be used both for receiving and sending messages.

For Oracle SOA Suite for healthcare integration, you need to associate an endpoint with document definitions and enable the endpoint to be able to start sending and receiving messages.

Figure 4-1 displays a sample endpoint, which is yet to be associated with a document definition.

Figure 4-1 Oracle SOA Suite for healthcare integration Sample Endpoint

Description of Figure 4-1 follows
Description of "Figure 4-1 Oracle SOA Suite for healthcare integration Sample Endpoint"

4.2 Creating Endpoints

The Oracle SOA Suite for healthcare integration user interface provides an Endpoints page where you can create and configure endpoints. This procedure describes how to create endpoints using the interface. For information about using the Healthcare Adapter, see Chapter 2, "Working with the Oracle Healthcare Adapter."

You can create endpoints both for bidirectional (MLLP) and single-directional (FILE, JMS) transport protocols. Bidirectional protocols enables you to send or receive response messages or functional acknowledgements (FAs) by using the same endpoint. However, single-directional protocols need to be configured to send and receive documents; only then you can send or receive messages or FAs per endpoint.

To create endpoints with bidirectional transport protocol (MLLP):

  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 icon as shown in Figure 4-2.

    Figure 4-2 Create Endpoint Icon

    Description of Figure 4-2 follows
    Description of "Figure 4-2 Create Endpoint Icon"

  3. In the Create window, enter the following and click OK, as shown in Figure 4-3:

    • 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 hostname and port of a remote computer or device. In general, this is for an outbound case.

    • Host Name: In case of an MLLP 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 4-3 Specifying Endpoint Parameters

    Description of Figure 4-3 follows
    Description of "Figure 4-3 Specifying Endpoint Parameters"

To create endpoints with single-directional transport protocol (FILE):

  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 icon.

  3. In the Create window, enter the following and click OK, as shown in Figure 4-4:

    • 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 and this folder does not contain the inbound or outbound messages or FAs. Inbound messages are expected in this folder, and outbound messages or FAs need to 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 4-4 Specifying Endpoint Parameters

    Description of Figure 4-4 follows
    Description of "Figure 4-4 Specifying Endpoint Parameters"

    Note:

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

Note:

See Appendix B, "Creating Endpoints with Different Transport Protocols" for more information on creating endpoints with different transport protocols.

4.2.1 Configuring Channels in an Endpoint with Single-Directional Protocols

When a bidirectional transport protocol (such as MLLP) is used to create an endpoint, the endpoint can handle both request and reply (inbound and outbound) or ACK. However, in the case of a single-directional transport protocol (such as File or FTP), typically, you can only configure either the inbound or the outbound channel, but not both together.

Oracle SOA Suite for healthcare integration, in the case of single-directional protocols, allows you to configure two communication channels (one for sending and one for receiving messages) as a single entity (endpoint) for management and monitoring. This concept allows you to enable or disable, view the supported documents, and display related monitoring data (message counts and actual messages) for the related channels at the same time.

Using this feature, when you use a single-directional transport protocol, you need to configure only one channel. The configuration for the other channel (for the reverse direction) is optional. The Oracle SOA Suite for healthcare integration console, in this case, displays that one channel has been configured to send or receive messages, but the other channel has not been configured yet as shown in Figure 4-5.

Figure 4-5 Undefined Secondary Channel

Description of Figure 4-5 follows
Description of "Figure 4-5 Undefined Secondary Channel"

You can configure the other channel by clicking the Configure link in the undefined channel section, as shown in Figure 4-6, and providing the required channel details in the configuration dialog box.

Figure 4-6 Defining the Secondary Channel

Description of Figure 4-6 follows
Description of "Figure 4-6 Defining the Secondary Channel"

The transport protocol and other settings are defined per channel. You can use different single-directional transport protocols for the two channels. For example, the one channel can use FTP, whereas the other channel can use File. The only requirement is that both the protocols used should be single directional.

Once you have defined both the communication channels and associated documents with the channels (see Section 4.3, "Associating an Endpoint with a Document"), the endpoint appears as Figure 4-7.

Figure 4-7 Single-Directional Endpoint with Both Channels Configured

Description of Figure 4-7 follows
Description of "Figure 4-7 Single-Directional Endpoint with Both Channels Configured"

You can edit the configuration of either of the channels if required. You can also delete the configuration of either of the channels by using the Delete links in the relevant channel section.

4.3 Associating an Endpoint with a Document

Once you have created an endpoint, you need to associate it with a document to enable the endpoint to send or receive messages. You can configure an endpoint to send or receive messages or both.

To associate a bidirectional endpoint with a document:

  1. Open the required endpoint.

  2. Configure the endpoint to send or receive messages:

    1. In the Send or Receive section of the endpoint, click the + icon to display the Document selection window.

    2. Select the required document definition from available document hierarchy, for example, ADT_A04_def. The document definition gets associated with the endpoint. You can specify whether you require functional acknowledgment, validation, or translation of the endpoint as well as required internal delivery channel, transport or agreement level callouts, and mapsets.

      Note:

      you can also drag-and-drop the document definition to the Send or Receive section.

      Figure 4-8 displays an endpoint associated with a document definition.

      Figure 4-8 Associating an Endpoint with Document Definitions

      Description of Figure 4-8 follows
      Description of "Figure 4-8 Associating an Endpoint with Document Definitions"

      Note:

      For FA, Functional ACK, Validation, Translation, Retry Interval, and Reattempt Count are disabled.

    3. Select any of the following document configuration options:

      Option Description

      Functional ACK

      Select to enable the functional acknowledgment for success or error criterion

      Validation

      Select to enable validation of the document against the configured ECS file

      Translation

      Select to enable the translation of XML to native format and vice-versa


    4. If any of the following have been defined for the endpoint, select them from the appropriate field: Internal Channel, Document Callout, Mapset, or Composite. For more information, see Chapter 6 Creating and Deploying Trading Partner Agreements in Oracle Fusion Middleware User's Guide for Oracle B2B.

  3. Select the Enabled check box and click Apply to enable the endpoint for sending and receiving messages.The Apply operation sometimes could take about 30 to 60 seconds. This is due to the XSD/ECS creation and metadata validation.

    Note:

    After making any changes to an endpoint, you can right-click the endpoint name in the left-side panel and click Refresh to update the endpoint.

    Note:

    You can enable or disable an endpoint by selecting or deselecting the Enabled check box and clicking the Apply button.

Associating a single-directional endpoint with a document

To associate a single-directional endpoint, such as File, the procedure is similar to that of a bidirectional endpoint. However, there are a few differences:

Note:

You can disassociate a document from an endpoint by selecting the specific document entry in the Documents section and then by clicking the Delete (X) button.

4.4 Enabling Sequencing for an MLLP Endpoint

The following options are available for sequencing:

For a single-directional endpoint:

4.5 Deleting an Endpoint

To delete an endpoint, log on to the Oracle SOA Suite for healthcare integration user interface. In the Configuration tab under the Design tab, select the endpoint name and click the Delete icon. You can also right-click the endpoint name and click Delete from the shortcut menu.

Note:

An enabled endpoint cannot be deleted. you need to disable the endpoint before deleting it.

4.6 Working with the Endpoint Window

You can use open the Endpoint window to view a list of existing endpoints. In addition, using the endpoint window, you can create, modify or delete endpoints. You can also perform bulk modification or deletion using this window by selecting all or the required endpoints and then performing the operation of your choice.

To access the Endpoint window:

  1. Log on to the Oracle SOA Suite for healthcare integration user interface.

  2. In the Configuration tab under the Design tab, double-click the Endpoint folder.

Figure 4-12 displays the Endpoint window.

Figure 4-12 The Endpoint Window

Description of Figure 4-12 follows
Description of "Figure 4-12 The Endpoint Window"