Configuring Outbound Interfaces

The Outbound Interface section of the Process Type editor has a Subscription tab where developers can enable schedule based and/or event-based subscriptions.

Schedules can be supported by clicking "Support Schedules" in the form. By making interface support schedule-based subscriptions, you are essentially saying "you will be allowed to schedule a convenient time at which this outbound interface will be called and the results delivered to you".

Event-based subscriptions mean "each time a particular action is called, this interface will be called and the results delivered to you." You choose which actions are applied from the "Add" dialog. This allows you to pick Model Type/Level and choose Actions from the list:

There are two catch-all items for "All Create Actions" and "All Write Actions". "All Create Actions" will be fired for any Action which is of the "Create" type, and "All Write Actions" stands for any Action which of the "Write" type. These "wildcard" types help developers avoid selecting long lists of actions individually when they really want an outbound interface to be called on any Create or Update.

The outbound interface's Generator also plays an important role in delivering a meaningful set of records to the end-user. Schedule-based "IntegrationSubscriptions" target Model-based (Net-change) or Report-based outbound generators. By contrast, event-based integration targets SqlDef-based outbound generators. Please refer to the Outbound Interfaces section of this document to get more information on Outbound Interface Generator types.

• Schedule-Based IntegrationSubscriptions submit an OutboundInterfaceWriteRequest or ReportOutboundInterfaceWriteRequest in order to generate the outbound file to deliver. An extra SqlParameter called SYS_INTEG_SUBS_ID is always provided, which contains the surrogate id of the Integration Subscription record. This allows using information specific to the subscription to refine the search results.

• Event-Based IntegrationSubscriptions submit a SysIdOutboundInterfaceWriteRequest in order to generate the outbound data. The same extra parameter SYS_INTEG_SUBS_ID is also available to this generator.

Please also note that CustomOutboundGenerator can be used to handle all of the scenarios above. If there is an interface that needs to support both Event and Schedule based Integration Subscription, CustomOutboundGenerator is the right generator type to use.

Finally, the Permissions section is used to control which Role Types are permitted to subscribe to this Interface. Only role types in this list will be able to see this interface in the UI when setting up subscriptions.