Content Data Validation Jython Scripts

The Content Data Validation Jython scripts are divided into main scripts and library scripts. Each "main" script must have the ValidateData function which is the entry point for the execution of data validation. The ValidateData function has the following parameters:

• TaskResults. Provides the API accessing data objects.
• Environment. Provides the API for accessing Environment information, such as the Probe Gateway name, the Probe Gateway IP, and the domain name.

The dataValidationlibs.xml file is a configuration file where you define which scripts to execute and which to execute as libraries. The file is divided into sections which logically define the data validation execution.

Example of the dataValidationlibs.xml File

<datavalidation parserClassName="com.hp.ucmdb.discovery.
library.communication.downloader.cfgfiles.
ContentDataValidationConfigFile">

	<script name="dataValidator1.py">

		<library name="validator1.py"/>

		</script>

	<script name="dataValidator2.py" cit="Node,Process">

		<library name="validator2.py"/>

		<library name="validator3.py"/>

	</script>

</datavalidation>

where:

• validator<x>.py is a library script.

  Libraries must be ordered according to their dependency. In this example, validator3.py uses validator2.py, so validator3.py appears after first validator2.py.

• The cit parameter lists the CITs that the script receives for validation. In this example, the dataValidator2.py script receives only Node and Process CITs for validation.

Handling Errors and Warnings

• addError/addWarning. Use this API from the TaskResults parameter to attach error/warning to triggered CIs. Bulk is reported to the UCMDB server.
• raise ContentDataValidationException. Use to report an error message if the bulk should be discarded.

Example of API Usage

• Main Script

#dataValidator1.py

import validator1

def ValidateData(TaskResults, Environment):

	logger.info('probe gateway is :', Environment.
getProbeGatewayID())

	logger.info('probe gateway ip is :', Environment.
getProbeGatewayIP())

	logger.info('probe domain is :', Environment.
getProbeManagerDomain())

objectsForUpdate = TaskResults.getResultObjects()

size = objectsForUpdate.size()

  if size > 0:

    for i in range(0, size):

        object = objectsForUpdate.get(i)

        validator1.validate(object, TaskResults)

        if object.getObjectClass() == 'host':

          TaskResults.addError(100, 'host CIT is not in class 
model')

  pass

• Library Script

#validator1.py

from com.hp.ucmdb.discovery.library.results.resultprocess import 
ContentDataValidationException

def validate(object, TaskResults):

  if object.getAttribute('description') == None:

    TaskResults.addWarning(100, 'No description set for the object 
of type ' + object.getObjectClass())

  if object.getAttribute('host_hostkey') == None:

   // fatal error, all bulk and all previous errors will be removed 
from bulk

   // this error will be shown in UI

   raise ContentDataValidationException, 'Attribute host_hostkey is 
absent'

Related Information