› KCM Getting Started Guide › Configure KCM instance › Select a tool for interactive document composition

Select a tool for interactive document composition

SetInstanceComposerUIRegistration.exe allows you to select what tool KCM will use for interactive document composition. You can specify the latest ComposerUI for HTML5 or the legacy ComposerUI for J2EE.

This tool resides in: <deploy root>\KCM\Programs\<version>\Management\Instance.

SetInstanceComposerUIRegistration.exe replaces the configuration of J2EE by means of ManageCM tool.

Running this tool is optional; if it is not run, KCM instance will use ComposerUI for HTML5.

Parameters

This tool has the following parameters.

Parameter

Required / Optional Description
Instance!Number Required

Numeric ID of the KCM instance.

For Docker deployment, it is always set to 1.
Registration!UseComposerUIForJ2EE Required

Boolean flag that specifies which tool will be used for interactive document composition.

  • If set to True, ComposerUI for J2EE (legacy tool) will be used.
  • If set to False, ComposerUI for HTML5 will be used.
Registration!ComposerUIForJ2EESite Optional

Specifies the name of the J2EE application to use for interactive document composition.

Note: This parameter is only relevant if Registration!UseComposerUIForJ2EE was set to True.

If omitted, defaults to composerui.

Registration!ComposerUIForJ2EEPage Optional

The start page of the J2EE application to use for interactive document composition.

Note: This parameter is only relevant if Registration!UseComposerUIForJ2EE was set to True.

If omitted, defaults to modelbegin.jsp

Notes on usage

  • SetInstanceComposerUIRegistration.exe requires a restart of the KCM instance for the configuration changes to come into effect.
  • Unless SetInstanceComposerUIRegistration is used, the KCM instance will automatically revert to ComposerUI for HTML5 (latest tool) each time it is restarted.