CCMInteractive contract type

The CCMInteractive contract type handles the definition, management, and composition of documents and document packs. It contains calls that are organized in a number of categories, each identified by a prefix in their name:

  • Designer: These calls provide access to the KCM Designer.
  • Compose: These calls create a document or a document pack, possibly through KCM ComposerUI for HTML5. The V1 version creates single documents. The V2 version creates document packs that contain one or more documents.
  • DocumentPack: These calls process existing document packs. For example, they give you the ability to review and modify document packs and document format conversions.
  • Admin: These calls provide administrative functionality.
  • SystemCheck: These calls provide functionality for checking the installation.

There are three versions of this contract type:

  1. V1: This contract type offers functionality that focuses on single documents. The compose calls deliver a single document. The contract offers no support for processing these documents further.
  2. V2: This contract type offers functionality that focuses on document packs. The compose calls deliver a complete document pack, and the contract offers functionality for manipulating and reviewing them.
  3. V3: This contract type allows import documents to be passed when composing a document pack, next to the functionality offered by V2.

For the list of available calls, see the next sections. For detailed information on these calls, see Available calls.