Setting Up Outbound Messages

The sample integration provided with the base product includes a predefined list of messages that are sent to an external system under various conditions. The messages are generated either from the sample FA integration algorithm or the sample real time appointment interaction. In each case, an NDS type is required to define properties of the message. Rather than hard-coding an NDS type, the integration algorithm and the user exit that manages the real time appointment interaction use a Notification Download Condition to reference the NDS type.

At implementation time, you should define an appropriate NDS type for each notification download condition listed below if it is applicable to your business.

The following download conditions are used in the sample FA integration algorithm:

  • FA Cancellation
  • FA Creation
  • FA Changed
  • FA Rescheduled
  • Appointment Cancel via FA Cancel

For each of the above NDS types, you must reference the following context types: Field Activity ID, Message ID. They should also reference an XAI inbound service that has been defined for the Extract FA Info service. The system provides an XAI inbound service called ExtractFAInfo, which you may use.

Note:

You can refer to the demonstration data provided with the system to view samples for pre-configured NDS types and their condition flags.

The following download conditions are used in the sample real time appointment interaction:

  • Get Available Appointments
  • Appointment Book
  • Appointment Cancel

The above NDS types do not need to reference a real XAI inbound service because the real time appointment interface is responsible for building the XML request.

Note:

You can refer to the demonstration data provided with the system to view samples for pre-configured NDS types and their associated XAI inbound services.

The following download conditions are used to send real time appointment messages in near real time.

  • Appointment Book - Near Real Time
  • Appointment Cancel - Near Real Time

Because the XML request is built by the appointment interface prior to the creation of the NDS, these NDS types should reference a special XAI inbound service called CDxProcessXDS. This service basically tells the download staging sender that the XDS already exists and doesn't need to be created.