DM_setFldUsageType

This method sets the usage type for the specified field in a value of type settings.

Note:

There is another version of this method which has no field argument. You can set the usage type for all fields at once. This is useful, for example, if you want to set all fields to usage type active to prevent automatic field usage type determination.

Syntax

Method syntax

Read syntax diagramSkip visual syntax diagram
>>-settings..DM_setFldUsageType--(--fldName--,--usageType--)---><

Function syntax

Read syntax diagramSkip visual syntax diagram
>>-DM_setFldUsageType--(--settings--,--fldName--,--usageType--)-><

Parameters

settings
A value of type DM_MiningSettings
fldName
A value of type VARCHAR(128)
usageType
A value of type INTEGER . Valid values for usageType are :
1 Active
The field is used by the algorithm.
2 Inactive (for all mining functions except Clustering)
The field is ignored when the model is built. Supplementary (Clustering): The field is not taken into account when the clusters are determined. Nevertheless, the statistical information for this field on those clusters is collected and written into the model.

Return Value

The return value is of type DM_MiningSettings



Feedback | Information roadmap