KnowledgeExpert Types

Describes the types used in Quality Rules Reuse

This page discusses:

CheckStatusEnum
KWECheck
KWECorrectFunction
KWEGenericRuleBaseComponent
KWELinkedRuleBase
KWERule
KWERuleBase
KWERuleBaseComponent
KWERuleBaseSet
KWERuleSet
KWETuple

CheckStatusEnum

Type used to find out the status of an expert check.

inheritancepath

ObjectType
 Literal
  Enumere
   CheckStatusEnum

Enumerated Values


Value	NLS Value	Comment
`Red`	Red	The check was solved and one object at least is False.
`Green`	Green	The check was solved and all objects are True.
`Black`	Black	The check was solved and the check has compilation errors or the solver does not find any objects matching the inputs of the check.
`NotSolved`	NotSolved	the check could not be solved.
`InteropValidity`	InteropValidity	Default value.
`Justified`	Justified	The check was justified.

Example

variables: mycheck: KWECheck

Body:

if (mycheck .Status == "Red")
	           ThisCheck.AddTupleFailed(mycheck)
Else
	           ThisCheck.AddTupleSucceeded(mycheck)

KWECheck

Type describing the checks created when clicking the Expert Check icon.

General Information


Property	Comments
`NLS name`	Expert Check
`New (EKL)`	-

Inheritance Path

ObjectType
 Feature
  KWEGenericRuleBaseComponent
   KWERuleBaseComponent
    KWECheck

Attributes


Name	NLS Name	Type	Comment
`CorrectFunction`	Correct Function	String	Enables you to modify the string contained in the Correct tab of the Expert Check Editor.
`CorrectFunctionComment`	Correct Function Comment	String	Enables you to modify the correct function comment in the Expert Check Editor.
`CorrectFunctionType`	Correct Function Type	Integer	Real enabling you to modify the type of the correct function in the Check Editor.
`Help`	Expert Check Help	String	Enables you to modify the help message in the Check editor.
`CreatedFrom`		ObjectType	Returns the check from which the check was created otherwise itself, if the check is volatile.
`Status`	Status	CheckStatusEnum	Lets you know the status of the expert check. Red: the check is solved and at least one object is False. Green: the check is solved and all objects are True. Black: the check is solved but has compilation errors or the solver cannot find any object matching with the inputs of the check. Not solved: the check is not solved. Justified: the check is justified.

Methods

The following methods are associated with this type:

KWECorrectFunction

General Information


Property	Comments
`NLS name`	Correct Function Type
`New (EKL)`	-

Inheritance Path

ObjectType
 Feature
  KWECorrectFunction

Attributes


Name used in EKL	NLS Name	Type	Comment
`Check`	Associated To	KWECheck	The check contains the Correct function. Return object with type KWECheck.
`ListFailedElements`	Current Objects Failed	List	Lists the facts under the failed tuple processed. Returns object with type List.
`TupleFailed`	Current Tuple Failed	KWETuple	The failed tuple processed. Return objet with type KWETuple.-

KWEGenericRuleBaseComponent

Type enabling you to reference the Quality Rules Reuse objects.

General Information


Property	Comments
`NLS name`	Expert Component
`New (EKL)`

Inheritance Path

ObjectType
 Feature
  KWEGenericRuleBaseComponent

Attributes


Name	Type	Comment
`Activated`	Boolean	Indicates if the sub-components of the rule base are activated.
`Comment`	String	Shows the comments appearing when creating the expert rule or the expert check and that can be modified using the Edit > Properties menu in the Quality Rules Reuse app.

Methods

The following methods are associated with this type:

GetRB

KWELinkedRuleBase

General Information


Property	Comments
`NLS name`
`New (EKL)`	-

Inheritance Path

ObjectType
 Feature
  KWEGenericRuleBaseComponent
   KWERuleSet
    KWELinkedRuleBase

KWERule

Type describing the rules that you create when clicking the Expert Rule icon.

General Information


Property	Comments
`NLS name`	Expert Rule
`New (EKL)`	-

Inheritance Path

ObjectType
 Feature
  KWEGenericRuleBaseComponent
   KWERuleBaseComponent
    KWERule

Attributes


Name	Type	Comment
`Priority`	Real	Indicates the rule priority level.
`CreatedFrom`	ObjectType	Returns the rule from which the rule was created otherwise itself, if the rule is volatile.

KWERuleBase

Type describing the rule base created when accessing the Quality Rules Reuse app.

General Information


Property	Comments
`NLS name`	Base Of Expert Elements
`New (EKL)`	-

Inheritance Path

ObjectType
 Feature
  KWEGenericRuleBaseComponent
   KWERuleSet
    KWERuleBase

Attributes


Name	Type	Comment
`WorkingMode`	String	-

Methods

The following methods are associated with this type:

GetRootsOfFacts

KWERuleBaseComponent

Type enabling you to access the For All field or the Body of the rule or the check in Read only mode.

General Information


Property	Comments
`NLS name`	Expert Check Or Rule
`New (EKL)`	-

Inheritance Path

ObjectType
 Feature
  KWEGenericRuleBaseComponent
   KWERuleBaseComponent

Attributes


Name	Type	Comment
`BodyString`	String	Contains the check or rule body.
`Language`	Integer	Corresponds to the language of the check: 1 for the Quality Rules Reuse language, 2 for Visual Basic, and 3 for KWE Advanced Language.
`VariablesString`	String	Variable specified in the For All field.

KWERuleBaseSet

General Information


Property	Comments
`NLS name`
`New (EKL)`	-

Inheritance Path

ObjectType
 Feature
  KWERuleBaseSet

KWERuleSet

Type describing the rule set that you create when clicking the RuleSet icon or when creating an expert check or rule.

General Information


Property	Comments
`NLS name`	Set Of Expert Elements
`New (EKL)`

Inheritance Path

ObjectType
 Feature
  KWEGenericRuleBaseComponent
   KWERuleSet

Attributes


Name	Type	Comment
`DirectChildren`	List	Attribute of List type enabling you to retrieve the items located below the ruleset.

KWETuple

General Information


Property	Comments
`NLS name`
`New (EKL)`

Inheritance Path

ObjectType
 Feature
  KWETuple

Attributes


Name	Type	Comment
`Description`	String	Lets you get and enter a description. It appears in the immersive report (xml/html).
`Label`	String	Lets you get and enter a description. This label appears in the immersive report (xml/html).
`ReportObjects`	List	Lets you get the list of the objects located under the tuple inserted using `AddTuple`.
`Validity`	Boolean	Lets you get the tuple validity: TRUE (succeeded) or FALSE (failed).
`Weight`	Integer	Lets you get and enter a weight. It appears in the immersive report (xml/html) and it is necessary for computing the total weight according to the selected mode.

Methods

The following methods are associated with this type: