› KCM API Guide › KCM API overview › System Check requests

System Check requests

The System Check functionality gives you the ability to verify that a deployed installation is up and running. These calls are placed in the CCMInteractive contract type:

  • To check the non-interactive document composition functionality, use the SystemCheck call. It produces a test PDF document. See SystemCheckV1.

  • To check the interactive composition functionality, use the SystemCheckInteractiveStart and SystemCheckInteractiveGet calls.

    You need to set up a KCM ComposerUI for HTML5 web application prior to using the calls.

    The SystemCheckInteractiveGet call initiates an interactive run that produces a PDF test document.

    After the interactive run has completed, you can use the SystemCheckInteractiveGet call to retrieve the produced PDF document that was initiated earlier through SystemCheckInteractiveStartV1.

    See SystemCheckInteractiveStartV1, SystemCheckInteractiveStartV2, SystemCheckInteractiveGetV1, and SystemCheckInteractiveGetV2.