› Work with KCM Designer › Work with Field Sets › Status Field Sets

Status Field Sets

You can use a Status Field Set in combination with Content Wizards. In a Content Wizard, you can optionally add Sections and Text Blocks as well as create editable Text Blocks.

During composition of a document or a Document Pack, the user can interactively choose to include the Section or the Text Block and/or to change the content of the editable Text Block.

Status Field Sets can be used to store information on the user's choice and to store the content of the changed editable Text Block.

This functionality does not apply to Text Block Lists, because user's choices made in a Text Block List cannot be stored in Status Field Sets.

You can indicate whether you intend to include an object in the Data Retrieval by adding either Yes or No value to such a Field directly. The Status Field Sets are invisible in every other place where Field Sets could be used. Fields of the Status Field Set have no default value and format.

Status Field as input

Although status fields are primarily used to capture interactive choices and edits, they can also be passed as part of the Data Backbone input to provide initial values for these choices and editable Text Blocks. For more information about the format of these status fields, see the following XSD files:

  • <KCM Installation>\Documentation\<version>\Resources\Schemas\Data Backbone\KCMStatusField.xsd
  • <KCM Installation>\Documentation\<version>\Resources\Schemas\Data Backbone\KCMTextBlock.xsd

Case-specific Text Blocks

Editable Text Block Status Fields allow you to implement case-specific Text Blocks. These Text Blocks are maintained not in KCM, but in the client application. The client application passes each case-specific Text Block in a Status Field to KCM at runtime and retrieves it afterwards. This way any edits can be stored by the client application.

The client application is responsible for transformation of case-specific Text Blocks between the business application-specific text format and the KCM Text Block format at the interface points between the business application and KCM.

The transformation from KCM Text Block format to the business application-specific format should be able to preserve the changes made in KCM Text Block Editor.

Any information lost in this transformation introduces a discrepancy between the business application data and the composed output.

During KCM composition run, Text Blocks are edited in the KCM Text Block editor that offers the following features:

  • Simple markup (bold, italic, underline)

  • Paragraph styles

  • Tables

  • Lists

  • References to Normal Fields

  • Indentation

  • Special characters (tab, non-breakable space, non-breakable hyphen)