Integration

In most of the cases KCM ComposerUI Server is used within the context of integrating application. Business applications often can not produce documents in a proper fashion due to lack of functionality. KCM ComposerUI fills this gap.

The following diagram shows a situation when a business application requires a document to be produced. This business application consists of a client and a server component, named "BA Client" and "BA Server," respectively. Note that this is a logical architecture that may be mapped on a physical architecture in many different ways.

integration

KCM ComposerUI and business application have two interfaces between them:

  1. An http interface between KCM ComposerUI on the web server and the BA Client on the workstation, supporting client-side integration of Master Template runs.

  2. A server-to-server interface between KCM Core and the BA Server, supporting server-side integration of Master Template runs.

Integration of an interactive Master Template run involves a number of steps:

  • Preparation of the Master Template run. This involves a number of calls from the BA Server to KCM Core. See Server side integration.
  • The Master Template run itself, consisting of a sequence of HTML Forms, offered by the http interface between KCM ComposerUI and the BA Client. See Client side integration.

  • Processing of the Master Template run. This can be achieved by specific implementations of some exit points on KCM Core. See Server side integration.

The fact that a single Master Template run consists of multiple steps introduces the notion of a session, which is shared by these steps.

Business application integration using prepared model is introduced in KCM ComposerUI 3.2.20. Although the current version of KCM ComposerUI can be used in combination with earlier versions of KCM Core, the integration method described in this chapter is not available in such configurations. Instead, one should use the Runmodel call for non-prepared model runs, which is described in chapter Calls. This chapter also describes model list integration using prepared model lists. This functionality is in KCM ComposerUI 3.2.25. When an KCM Core version 3.2.24 or earlier is used, one should use the call Listmodels for non-prepared model lists, which is also described in chapter Calls.