Identification Rule Schema

Search for	Example	Results
A single word	`cat`	Topics that contain the word "cat". You will also find its grammatical variations, such as "cats".
A phrase. You can specify that the search results contain a specific phrase.	`"cat food"` (quotation marks)	Topics that contain the literal phrase "cat food" and all its grammatical variations. Without the quotation marks, the query is equivalent to specifying an OR operator, which finds topics with one of the individual words instead of the phrase.

Search for	Operator	Example
Two or more words in the same topic	`AND` `and` `+` (plus symbol) `&` (ampersand)	`cat AND dog` `"cat food"+milk` `"cat food"&"dog food"`
Either word in a topic	`OR` `or` `\|` (pipe)	`cat OR dog` `cat \| dog`
Topics that do not contain a specific word or phrase	`NOT` `not` `!` (exclamation point)	`NOT cat` `! dog`
Topics that contain one string and do not contain another	`^` (caret)	`cat ^ mouse`
A combination of search types	`( )` parentheses	`cat + (dog \| mouse)` `cat \| dog + (! mouse)`

Element

Attributes

Name and Path

Description

identification-config

The parent element for the identification rule document.

Name. description

Description. A textual description of the identification rule.

Is required. Optional

Type. String

Name. type

Description. The CI type to which the identification rule will apply.

Is required. Required

Type. String

identification-criteria

(Identification-config)

The parent element for all the possible identification criteria for the CI type. For details, see Identification Criteria. The identification criteria may contain many identification-criterion elements. Can appear at most once.

match

(Identification-config)

The parent element for all the possible match criteria for the CI type. For details, see Match Criteria. Can appear at most once.

multiple-match-resolving (Identification-config)

When two or more CIs of the CI type are identified to one another, they may be of any descendant CI type as well. This element states that one of the descendant CI types is preferred over the others. Can appear at most once.

Name. preferred-type

Description. Specifies the CI type of the CI that will be preferred when there are multiple matches which cannot be merged.

Is required. Optional

Type. String

preferred-property

(identification-config >

multiple-match-resolving)

This element specifies the property value of the CI that will be preferred when there are multiple matches which cannot be merged.

Name. name

Description. The name of the property.

Is required. Required

Type. String

Name. value

Description. The value of the property.

Is required. required

Type. String

Name. priority

Description. The priority of this preferred property.

Is required. Optional

Type. Integer

identification-criterion (Identification-config > identification-criteria)

This element defines a single identification criterion. The criterion may contain many conditions for identification, and for the criterion to return True, all of them must return True.

Name. targetType

Description. Indicates for which CI type this criterion is valid. If this attribute is omitted, then the criterion is applied to any derived type.

Is required. Optional

Type. String

Name. isTargetTypeDerived

Description. Specifies whether the target type is a derived type of the current CI type.

Is required. Optional

Type. String

key-attributes-condition (identification-config > identification-criteria > identification-criterion)

This special condition states that the CI type is identified by its key properties and CI type name, and not by any identification criteria. If this condition exists, it should be the only one in the criterion, as well the only criterion in the identification section. Can appear at most once.

attribute-condition (identification-config) identification-criteria > identification-criterion -OR- identification-config identification-criteria > identification-criterion > connected-ci-condition -OR- identification-config > match > validation-criteria )

Defines a condition based on an attribute.

Name. attributeName

Description. The name of the attribute.

Is required. Required

Type. String

Name. autoExcludeThreshold

Description. If the number of identification candidates with the same attribute value exceeds this threshold, then that value is automatically excluded from the identification process.

Is required. Optional

Type:

Positive integer.
A value of 0 disables this feature.

Name. masterValue

Description. For the purpose of fulfilling the condition, the value defined here is considered equal to any other value.

Is required. Optional

Type. String

Name. operator

Description. Specifies whether the equality of attribute values should be case sensitive or not. The default is case sensitive.

Is required. Optional

Type. One of the values: Equals or EqualsIgnoreCase

Name. includeNullValue

Description. Specifies whether a CI should still be considered as a valid value if it has a null (empty) value in the attribute, and the condition will process normally; or is the condition ignored and the reconciliation engine moves to the next criterion. Default value is False

Is required. Optional

Type. Boolean

Name. conditionType

Type. One of the following values:

approveAndContradict condition is used for both approving and contradicting CIs (default).

contradictionOnly condition is used to contradict two CIs.

approvalOnly condition is used for approving CIs only.

connected-ci-condition (Identification-config identification-criteria > identification-criterion -OR- identification-config > match > verification-criteria -OR- identification-config > match)

Defines a condition based on connected CIs. The connected condition may contain attribute conditions. If no attribute conditions exist, the condition matches the connected CI type using its own identification rule.

Name. ciType

Description. The type of CI that is assumed to be connected to the CI type to which this rule belongs using the linkType attribute.

Is required. Required

Type. String

Name. linkType

Description. The type of link that the ciType attribute uses to connect to the CI type to which this rule belongs

Is required. Required

Type. String

Name. isDirectionForward

Description. The direction of the link. Default value is True (from the rule’s CI type to ciType).

Is required. Optional

Type. Boolean

overlap-fixed-operator (Identification-config > identification-criteria > identification-criterion > connected-ci-condition)

Defines the fixed number of matches to connected CIs that are needed to fulfill the condition for the connected-ci-condition element to return True. Either this or overlap-operator must exist.

Name. number-of-matches

Description. The number of matches.

Is required. Required

Type. Integer

overlap-operator (Identification-config > identification-criteria > identification-criterion > connected-ci-condition)

Defines the percent of connected CIs (from the total input number of connected CIs) that are needed to fulfill the condition for the connected-ci-condition element to return True. Either this or overlap-fixed-operator must exist.

Name. match-percent

Description. The percent of matches.

Is required. Required

Type. Integer between 1 and 100

verification-criteria (Identification-config > match)

The parent element for all the possible verification criteria for the CI type. For details, see Match Criteria. The verification criteria must contain at least one verification-criterion element. Can appear at most once.

verification-criterion (Identification-config > match > verification-criteria)

This element defines a single verification criterion. The criterion may contain many conditions for verification.

Name. targetType

Description. The derived CI type for which this criterion is valid. If this attribute is omitted, then the criterion is applied to any derived type.

Is required. Optional

Type. String

Name. isTargetTypeDerived

Description. Specifies whether the target type is a derived type of the current CI type.

Is required. Optional

Type. Boolean

Name. numberOfConflictsToFail
Identification

Description. The number of conflicting conditions that will cause the current criterion to fail.
Default Value: 1.

Is required. Optional

Type. Integer

validation-criteria (Identification-config > match)

The parent element for all possible validation criteria for the CI type. For details, see Match Criteria. The validation criteria must contain at least one validation-criterion element. Can appear at most once.

validation-criterion (Identification-config > match > validation-criteria)

This element defines a single validation criterion. The criterion may contain many conditions for validation.

Name. priority

Description. The criterion’s priority.

Is required. Required

Type. Integer

Name. targetType

Description. The derived CI type for which this criterion is valid. If this attribute is omitted, then the criterion is applied to any derived type.

Is required. Optional

Type. String

Name. isTargetTypeDerived

Description. Specifies whether the target type is a derived type of the current CI type.

Is required. Optional

Type. Boolean

Name. numberOfConflictsToFail
Identification

Description. The number of conflicting conditions that will cause the current criterion to fail. Default Value: 1.

Is required. Optional

Type. Integer

Connect

ITOM Marketplace

IT Service Management blog

Documentation Forum

Micro Focus Support and News Forum

Learn

Micro Focus Support Online

Micro Focus Support Downloads

Micro Focus Software Education

Contact

Send Help Center feedback

Submit Service Request

View Service Requests