13 Configuring System Settings

This chapter describes how to configure the appearance of the healthcare integration user interface and how to configure runtime processing for healthcare integration applications.

This chapter includes the following topics:

13.1 Configuring the Runtime Settings

Runtime settings control how Oracle SOA Suite for healthcare integration handles certain functions, like sequencing, functional acknowledgments, batch processing, Oracle BAM enablement, default queues, and so on.

Runtime settings are shared between Oracle SOA Suite for healthcare integration and Oracle B2B; changing the settings for one also changes the settings for the other. Oracle B2B settings in Oracle Enterprise Manager also apply to Oracle SOA Suite for healthcare integration. For more information about Oracle B2B settings in Oracle Enterprise Manager, see "Configuring Oracle B2B" in Oracle Fusion Middleware Administrator's Guide for Oracle SOA Suite and Oracle Business Process Management Suite.

Figure 13-1 Runtime Settings

Description of Figure 13-1 follows
Description of "Figure 13-1 Runtime Settings"

To configure the runtime settings

  1. On the Oracle SOA Suite for healthcare integration user interface, click the Designer tab and then click the Administration tab.

  2. Expand Settings and then select Runtime.

  3. Modify the value of any of the properties listed in Table 13-1.

  4. Do one of the following:

    • To save your changes, click Apply.

    • To change the settings back to their previous values, click Revert.

Table 13-1 Runtime Configuration Settings

Field Description

Acknowledgment

Functional Ack Handled Automatically

An indicator of whether Oracle SOA Suite for healthcare integration automatically generates the functional acknowledgment (FA) for inbound HL7 messages. Select this option to automatically generate the FA; inbound FA messages are consumed when this option is selected.

Deselect this property if you do not want to automatically generate the FA document. The backend application (middleware) must generate the FA and provide it to Oracle SOA Suite for healthcare integration as an outbound message. When this property is deselected, inbound FA documents are passed back to the backend application.

If the document does not require an FA (as indicated by the endpoint-level setting), then this property is ignored. This property is selected by default.

If the FA is marked as expected in an endpoint, then the message is placed into the MSG_WAIT_FA state and the backend application is expected to generate the FA and push it to Oracle SOA Suite for healthcare integration as an outbound message back to the partner.

When Functional Ack Handled Automatically is not selected, Notify Inbound Functional Acks must also be deselected in order for the inbound FA to be sent to the backend application. If Notify Inbound Functional Acks is selected and Functional Ack Handled Automatically is deselected, the incoming functional acknowledgment generates only a notification and the FA document itself is not sent back to the backend application.

The following limitations apply when generating the FA from the backend application:

  • The FA is correlated with the original message based on the ReferToMsgID value set in the enqueue properties. The FA is correlated based on control numbers also.

  • If the FA indicates that there was an error in the received message, the status of the correlated message is not updated to indicate an error. The correlated message is updated to MSG_COMPLETE.

These limitations are not present when the FA is generated by Oracle SOA Suite for healthcare integration (that is, when this property is selected).

Functional Ack Internal Properties

An indicator of whether to generate the internal properties structure in the functional acknowledgment using the original message internal properties.

By default, this property is deselected, which means that the functional acknowledgment uses the original message-internal properties.

Notify Inbound Functional Acks

An indicator of whether Oracle SOA Suite for healthcare integration sends an acknowledgment notification to the application when a functional acknowledgment is received. Select this property to send the acknowledgment notification.

When Functional Ack Handled Automatically is not selected, Notify Inbound Functional Acks must also not be selected in order for the inbound FA to be sent to the backend application. If Notify Inbound Functional Acks is selected and Functional Ack Handled Automatically is not selected, the incoming functional acknowledgment generates only a notification and the FA document itself is not sent back to the back-end application.

Miscellaneous

Auto Stack Handler

An indicator of whether the stack handler for MLLP processes the stacked messages in automatic mode. Select this property to process in automatic mode. By default, this property is selected.

Log Payload

An indicator of whether to log the payload in a diagnostic log. When this property is selected, the payload is logged, but this also depends on the log level setting. Error messages are logged by default. Payload logging is useful for diagnostic purposes, but may be undesirable for security reasons. By default, this property is not selected.

Note: You need to set the log-level setting in the Enterprise Management console to TRACE to be able to log payloads. The available log-level settings are TRACE, NOTIFICATION, INCIDENT_ERROR, ERROR, and WARNING.

Exception Queue

A JMS internal delivery channel for the host to use as the exception queue. Exception notifications are sent to the queue name you specify here. A null value for this parameter means that exceptions are sent to the default JMS queue (B2B_IN_QUEUE) if Use JMS Queue as default is selected or to the AQ queue (IP_IN_QUEUE) if Use JMS Queue as default is not selected.

AQ queues are not supported for use as custom exception queues.

Generic Message Type

An indicator of whether Oracle SOA Suite for healthcare integration should ignore the HL7 trigger event. By default, this property is not selected.

Outbound Dispatcher Count

The number of dispatchers used for handling the outbound messages. This is used in message sequencing.

Inbound Dispatcher Count

The number of dispatchers used for handling the inbound messages. This is used in message sequencing.

Auto Stack Handler Interval

The time interval in seconds for the stack handler to process the stacked messages. Enter comma-separated values for the intervals.

Partial Batch Commit Size

The number of records to be committed when there is a large number of business messages for a message exchange.

Enable BAM

An indicator of whether to send runtime information to Oracle BAM. For more information, see "Monitoring Instance Message Data With Oracle BAM" in the Oracle Fusion Middleware User's Guide for Oracle B2B.

BAM Polling Interval

The polling interval in minutes for Oracle BAM. This is ignored if Oracle BAM is not enabled.

Ignore Correlation

An indicator of whether to ignore correlation errors when an acknowledgment is received and correlation fails. Acknowledgments are correlated to the actual business message of the sender. If the correlation fails, an exception is generated and the acknowledgment processing stops. To ignore the correlation in this case and continue processing the acknowledgment, select this property. By default, this property is not selected.

Non Purgeable

Note: The nonpurgeable parameters retain their values even after metadata repository is purged.

Callout Directory

The directory for the callout JAR file location (if you do not use the default callout). The callout directory path cannot end with a forward or backward slash (/ or \).

The default file location, /MyCalloutDir, is retained after purging the metadata repository.

Use JMS Queue as default

An indicator of whether to use the default JMS queues. If this selected, Oracle SOA Suite for healthcare integration starts to poll on the JMS queue B2B_OUT_QUEUE for outbound messages, and delivers all inbound messages to B2B_IN_QUEUE. Polling on IP_OUT_QUEUE is stopped.

If this option is not selected (the default), Oracle SOA Suite for healthcare integration starts to poll on the AQ queue IP_OUT_QUEUE for outbound messages, and delivers all inbound messages to IP_IN_QUEUE. Polling on B2B_OUT_QUEUE is stopped. When a non-Oracle database is used and therefore no AQ queues are available, the JMS queues are used no matter how this option is set.

Performance

Large Payload Size

The large payload size, in bytes. The default value is 2,000,000 (2MG).

Large Payload Directory

The directory to store large payloads. The default directory is /tmp. For Windows-based systems, change the directory to an appropriate directory, such as C:\temp.

13.2 Configuring the User Interface Settings

User interface settings control the appearance of the reports and dashboards on the healthcare integration user interface.

Figure 13-2 User Interface Settings

Description of Figure 13-2 follows
Description of "Figure 13-2 User Interface Settings"

To configure the time slider periods for reports and dashboards

This procedure changes the values listed on the time sliders that are used on the Reports and Dashboard pages. You can select up to nine different time periods for the sliders.

Figure 13-3 Time Slider in the Reports Filter Panel

Description of Figure 13-3 follows
Description of "Figure 13-3 Time Slider in the Reports Filter Panel"

  1. On the Oracle SOA Suite for healthcare integration user interface, click the Designer tab and then click the Administration tab.

  2. Expand Settings and then select UI.

  3. In the Enabled Time Slider Periods section, select the time periods you want the sliders to display.

    You can select up to nine periods, so be sure to deselect time periods you do not need to make room for the ones you want to display. As you change your selections, you can see the changes to the dashboard summary slider on the right.

  4. To restore the time period selections to the default, click Restore Defaults.

  5. When you are done making changes, click Apply to save your changes.

To configure reports

You can configure certain display attributes for the Reports page, such as how many records to display, how often to auto-refresh, and payload display.

  1. On the Oracle SOA Suite for healthcare integration user interface, click the Designer tab and then click the Administration tab.

  2. Expand Settings and then select UI.

  3. Change the value of any of the properties described in Table 13-2.

    Table 13-2 Configuration Properties for Reports

    Property Description

    Auto-Refresh Interval (secs)

    The length of time (in seconds) the browser should wait between automatically refreshing information in a report.

    Page Size

    The number of messages to display on each page of a report.

    Show Payload

    An indicator of whether to display the message payload regardless of user permissions. Select Yes to display the payload; otherwise select No.

    Payload Display Size (bytes)

    The maximum number of bytes of each message payload to display. If a payload is larger than the number of bytes specified, none of the payload is shown.

  4. When you are done making changes, click Apply to save your changes.

To configure the default time period for the dashboard summary

This procedure changes the default time period for the information shown on the Dashboard Summary pages. For example, if you select 5 Days, when you open a dashboard you will see a summary of the past five days for the selected endpoints; if you select Week, you will see a summary of the past week.

  1. On the Oracle SOA Suite for healthcare integration user interface, click the Designer tab and then click the Administration tab.

  2. Expand Settings and then select UI.

  3. In the Dashboard Summary section, move the pointer on the slider to the time period you want to use as the default for the Dashboard Summary pages.

  4. When you are done making changes, click Apply to save your changes.

To configure endpoint details on the dashboard

You can configure the appearance of the Endpoint Details page of a dashboard. This is the page that appears when you click the Endpoint Details icon for an endpoint on the Dashboard Summary page.

  1. On the Oracle SOA Suite for healthcare integration user interface, click the Designer tab and then click the Administration tab.

  2. Expand Settings and then select UI.

  3. Change the value of any of the properties described in Table 13-3.

    Table 13-3 Configuration Properties for Endpoint Details

    Property Description

    Number of Gauge Columns

    The number of message type gauges to display in each row of the Document Type Processed section.

    Auto-Refresh Interval (secs)

    The length of time (in seconds) the browser should wait between automatically refreshing endpoint details in a dashboard.

    Document Type Display

    An indicator of whether to display document type information in gauge format or in table format. Examples of each format are shown in Figure 13-4 and Figure 13-5.

    Slow Threshold for Sequencing (secs)

    The number of seconds that a sequence message can wait in the queue before processing is considered slow. Once processing is considered slow, the status appears as yellow on the Endpoint Details page of a dashboard.

    Figure 13-4 Document Type Information in Gauge Format

    Description of Figure 13-4 follows
    Description of "Figure 13-4 Document Type Information in Gauge Format"

    Figure 13-5 Document Type Information in Table Format

    Description of Figure 13-5 follows
    Description of "Figure 13-5 Document Type Information in Table Format"

  4. When you are done making changes, click Apply to save your changes.