Methods, Export – Echelon OpenLNS User Manual

Page 239

Advertising
background image

OpenLNS Programmer's Reference

202

All the other properties contain information describing the errors that were discovered in the

database during the validation. This information includes how many errors were discovered

during the validation, how many of the errors OpenLNS was able to repair, how many of the

errors OpenLNS was not able to repair, and the

ErrorSummaries

property, which contains a

collection of

DatabaseValidationErrorSummary

objects. Each

DatabaseValidationErrorSummary

object contains information describing a certain type of

error that was discovered during the database validation.

The following table summarizes the

DatabaseValidationReport

object.

Description

A single

point of data in a LONWORKS network

.

Added to API

LNS Release 3.20.

Accessed Through

Network object.

Default Property

None.

Methods

Export

Properties

ClassId

ErrorSummaries

Parent

PassedValidation

RepairedErrors

TotalObjectsValidated

UnrepairedErrors

Methods

The DatabaseValidationReport

object contains the following methods:

Export

Export

Summary

Contains information summarizing the results of a database

validation that was performed on a network. You can use this

method to export the contents of the database validation report

to a specified directory

.

The contents of the validation report will be exported in XML

format. You must enter the directory and filename that will

contain the report as a valid system path. If OpenLNS is

unable to open the target directory for writing, or if the

specified filename already exists and the overwriteExisting

element is set to False, the LCA, #149

lcaErrorInvalidExportFilename exception will be thrown.

Availability

Local clients.

Syntax

validationReport.Export path, overwriteExisting

Element

Description

validationReport

The

DatabaseValidationReport object

to be acted upon

object being acted

upon.

path

A string containing the path and

Advertising