<< Click here to display Table of Contents >> Navigation: How It Works > Training Operations:

SchemaTrainingResults

Contents

Class Name: SchemaTrainingResults

Scope: Public - Restricted - No Public Constructor. Results of a Training Operation performed by public classes like the HL7StringAnalyzer class, HL7FileAnalyzer class, etc <future>.

Properties (ReadOnly)

Metrics and Performance

Will be set on every operation regardless of success

DateTime TrainingStarted - When the Training Operation started.

DateTime TrainingEnded - When the Training Operation ended.

TimeSpan TrainingTook - TimeSpan object (TrainingEnded - TrainingStarted).

Integer PassNumber - How many iterative attempts were made to train the Schema with the message.

Integer TotalSuggestions - Number of potentially fixable SQL issues that were found.

Integer TotalSuggestionsFixed - Number of potentially fixable SQL issues actually executed during the operation.

Boolean HasTruncationIssues - Will be True IF the Training Operation encountered any data truncation issues.

Boolean HasMissingColumns - Will be True IF the Training Operation detected any missing data columns.

Boolean HasAddressableIssues - Will be True IF the Training Operation detected any problem which could be fixed by calling the ExecuteAllSuggestions() method.

Boolean TrainingWasSuccessful - If False there will be an exception/reason in the LastException property see Common Exceptions Interface.

LIST OBJECTS

List <of String> HL7SegmentsWithMissingTables. A list of "tips" for HL7 segments which were in the message but have no corresponding segment data table.

List <of String> AddSegmentSuggestions. A list of SQL Create Table statements which addresses HL7SegmentsWithMissingTables.

List <of String> AddSegmentBSuggestions. A slightly different list of SQL Create Table statements. This addresses issues where the Schema Tables contain an _A table for a Segment but the message indicated that a _B table is needed to contain the data.

List <of String> AddColumnSuggestions. A list SQL Add Column statements which addresses both missing columns and missing HL7 fields.

List <of String> AlterColumnSuggestions. A list SQL Alter Column statements which addresses Truncation issues detected during the Training Operation.

Public Methods

Boolean ExecuteAllSuggestions(SQLSchemaAPIKey myKey).

Parameter 1: myKey will be of type SQLSchemaAPIKey. The parent Key object.

Returns: Boolean (Success / Failure). On failure see the Common Exceptions Interface.

Description: When called this method will create a SQL Transaction which will execute all commands stored in the List properties which contain SQL Commands. It will execute them in this order AddSegmentSuggestions, AddSegmentBSuggestions, AddColumnSuggestions and AlterColumnSuggestions. If these Lists are all empty nothing happens and True is returned.

NOTE: Calling this method improperly can cause an unhandled (on purpose) exception. Your SQLSchemaAPIKey.AllowAPIToAlterSchema property must be True. See Unhandled Exceptions.

String GetReport().

Returns: A summary report.

Exception Handling: Follows the Common Exceptions Interface.