Classification of Records
You can classify records into the specified classification using the <ClassificationSchemes> context while adding or modifying a record.
The following actions are supported for the classification scheme:
- Classify – Classifies a record into the specified classifications. This is default action.
- Unclassify – Unclassifies a record from the specified classifications.
- UnclassifyAll – Unclassifies a record from all existing classifications.
- Replace – Unclassifies a record from all existing classifications and classifies them into specified classifications.
Specify the classifcations in the following sequence:
- Name of a classification scheme
- Actions for a classification scheme
- Classification code: Specify the code hierarchy by nesting the ClassificationCode tag. Ensure that you specify the classification code and not the classification code name.
Refer to the following request example:
<ClassificationSchemes> <ClassificationScheme name = "GamesAndToys" action="Classify"> <ClassificationCode code="86010100"> <ClassificationCode code="10005133"> <ClassificationCode code="20000045"/> </ClassificationCode></ClassificationCode> </ClassificationScheme> </ClassificationSchemes>
Specify the exact hierarchy of classifications in the context starting from level one. If there is a mismatch in hierarchy, an error is returned.
Alternatively, instead of classifying record by adding it in the request you can add it in the context variable.
<Context> <Variable name="CLASSIFICATIONCODEPATH"> GamesAndToys/86010100/10005133/20000045</Variable> </Context>
and have the following rulebase
<constraint>
<name>rulebase-ACTION-CATEGORIZE</name>
<action>
<categorize incremental="true">
<var>context_classificationcodepath</var>
</categorize>
</action>
</constraint>
CLASSIFICATIONCODEPATH in webservice context is a Name- Value pair. You can use any Name-Value pair to do classification using rulebase and webservice context. SchemeNames followed by a forward slash (/) delimter is used to define a complete codepath. If you have multiple codepath use comma(,) separator.
You can use it with Record ADD/MODIFY, Record Query web services. It can be used to get List of Values, provide access based on the category.
The sample request and response XML files for all actions are available in the following locations: