Example of Index Entity Checkpoint

By using the Index Entity Checkpoint, you can schedule a job to checkpoint the provided list of Netrics tables or index entities when the trigger is fired. Checkpoint signifies that the Netrics tables are saved to a permanent storage device, and the saved copies can be quickly restored at a later time on a periodic intervals. As a result of checkpoint, you can see the data files getting created in the specified checkpoint directory.

To checkpoint, the Netrics server must have been started with check pointing or restore enabled (use -R option).
  • -R restoredir: enables checkpoint or restore using the indicated directory as the checkpoint or restore directory. The indicated directory must already exist. If this argument is not specified, the checkpoint feature is disabled.
  • -A Auto restore: restores all checkpointed tables in the restore directory. Restores upon start up.

  • -a common-dir: restores from a common directory. Upon start up all checkpointed tables in the indicated directory are restored. Checkpointing is not enabled by this option, although it may be used with the -R and -A options.

For more information, see "CheckpointWorkflow Activity" in TIBCO MDM Workflow Reference.
To checkpoint all index entities, specify a comma separated index entity names and an asterisk (*) in the value of <JobInputParam> tag. Ensure that the index entity names that you specify in this job should match with the index entities specified in the IndexerConfig.xml file. The Job class for Index Entity Checkpoint is com.tibco.dq.scheduler.NetricsTableCheckpointScheduler. Refer to the following sample of the Index Entity Checkpoint process: 
<CronSchedules> 
		<Name>checkpointscheduler</Name>
		<Jobs>
			<Job>
				<Name>Checkpoint all Tables/Index Entities</Name>
				<Triggers>
					<TriggerExpression>0 0/30 * * * ?</TriggerExpression>
				</Triggers>
				<JobDetails>
					<Description>
         Scheduled job to Checkpoint the given list of Netrics Tables/ Index Entities, when the trigger is fired. The Index Entity Names specified in this job should match with the Index Entities specified in Config\IndexerConfig.xml. The text value of 'JobInputParam' tag with attribute 'IndexEntityNames' is a comma separated String and using '*' would Checkpoint all the Index Entities.
                    </Description>
					<JobDetailsClass>com.tibco.dq.scheduler.NetricsTableCheckpointScheduler</JobDetailsClass>
				</JobDetails>
				<ExecuteOnStartup>false</ExecuteOnStartup>
				<JobInput>
                    <!-- This would checkpoint the Index Entities IndexEntity_Name1 and IndexEntity_Name2 -->
					<!-- <JobInputParam name="IndexEntityNames">IndexEntity_Name1, IndexEntity_Name2</JobInputParam> -->
                    <!-- This would checkpoint all available Index Entities.-->
					<JobInputParam name="IndexEntityNames">*</JobInputParam>
				</JobInput>
			 </Job>
		 </Jobs>
     </Schedule>
</CronSchedules>
The sample IndexCheckpointScheduler.xml file is available in the $MQ_HOME\common\standard\samples\Scheduler sample folder.