Configuring Checkpoints

A configuration file must be written before use. The general form of a checkpoint configuration file follows. 

      # Name
      # checkpointconfig.ini
      #
      # You can put comments in C shell syntax
      # Blank lines are also allowed
      [ checkpointconfig : checkpoint::Config ]
      applicationVersion = my_application_version
      checkpointDirectory = my_checkpoint_directory
      checkpointNodeName = my_checkpoint_nodename
      checkpointLoader = full_scoped_name_for_loader
      crcMethod = CRCNone
The following table explains the properties in this configuration.

Property

Description

applicationVersion

Contains the application version used at the checkpoint level. This information is part of a checkpoint metadata. It enables developers to trigger a checkpoint migration for application level data.

checkpointDirectory

Contains the relative or absolute path to the folder where checkpoints and swap points are stored. This overrides the Cartridge InstanceBase configuration parameter CheckPointDirectory.

checkpointNodeName

Specifies the Fulfillment Provisioning node name. This name is part of the key identifying a checkpoint. When multiple nodes are deployed the Fulfillment Provisioning node names must all be different.

checkpointLoader

The fully scoped name of the interface implementing a checkpoint loader. This class is used when reloading the checkpoints.

crcMethod

The name of a CRC (Cyclic Redundat Check) method to use in order to ensure checkpoint integrity. CRC is disabled by default. Writing or reading a checkpoint is 30% slower when enabling this behavior.

The configuration file is: 

$SW_HOME/$NODENAME/conf/checkpointconfig.ini

where $SW_HOME is the Fulfillment Provisioning installation folder and $NODENAME is the KIS node name. Sample configuration files are provided with the Fulfillment Provisioning archive.