IDOL Category Component 24.3

# <autn:category>

The `<autn:category>` tag marks the limits of each category that you want to import in your XML file. You can include one or more `<autn:category>` tags inside the `<autn:categories>` tag, and `<autn:category>` tags can also contain child `<autn:category>` tags.

The following table lists the tags that are allowed in `<autn:category>`.

Tag name | Number allowed | Required
--- | --- | ---
<autn:name> (required) | one | Yes
<autn:id> | one | No
<autn:parent> | one | No
<autn:refersto> | one | No
<autn:trainingelement> | one or more | No
<autn:simplecat> | one | No
<autn:relevancecat> | one | No
<autn:details> | one | No

## <autn:name> (required)

The `<autn:name>` tag sets the name of the category. You must include one `<autn:name>` within each set of `<autn:category>` tags. For example:

    <autn:name>UKpolitics</autn:name>

Tags allowed within `<autn:name>`: none

## <autn:id>

The `<autn:id>` tag sets the IDOL category ID. If a category with this ID already exists in the server, IDOL uses the OnConflict ACI parameter to determine the action to take.

For further information, see the CategoryImportFromXML OnConflict parameter.

## <autn:parent>

The `<autn:parent>` tag identifies the ID of the parent category. This option is effective only if you set Flat to `True` in the CategoryImportFromXML action.

## <autn:refersto>

The `<autn:refersto>` tag identifies the ID of the category to which the new category refers. This information is used to create a category that refers to another, and which inherits its fields, training, and special documents. This option is effective only if you set Flat to `True` in the CategoryImportFromXML action.

## <autn:trainingelement>

The `<autn:trainingelement>` tag identifies the training element for a category. IDOL Server identifies concepts that belong to the category from this training set. You can include one or more `<autn:trainingelement>` tags in each set of `<autn:category>` tags.

The following table lists the tags that are allowed in `<autn:trainingelement>`.

Tag name | Number allowed | Required
--- | --- | ---
One or more of these: |
<autn:type> | one | Yes
<autn:content> | one | See below
<autn:language> | one | No
<autn:reference> | one | See below
<autn:docid> | one | See below
<autn:database> | one | No

<autn:type>

The `<autn:type>` tag sets the type of training to be used by `<autn:trainingelement>`. Each `<autn:trainingelement>` should contain only one `<autn:type>` tag.

The following table describes the values that are valid for `<autn:type>`.

Options for <autn:type> | Description
--- | ---
`TRAININGTEXT` | Identifies the training type as text only.
`BOOLEAN` | Identifies the training type as Boolean. You must define the Boolean operator in the `<autn:content>` tag. For example:
    <autn:type>BOOLEAN</autn:type>
    <autn:content>(phone AND mobile)</autn:content>
`URLDOWNLOAD` | Identifies text from a URL to use for training.
`DREDOCUMENT` | Identifies the training type as a document indexed in IDOL. The document is specified by either `autn:reference` or `autn:docid`.

<autn:content>

The `<autn:content>` tag specifies the actual training text or Boolean expression. This tag is required if <autn:type> is `TRAININGTEXT`, `BOOLEAN`, or `URLDOWNLOAD`.

For more information, see <autn:type>.

<autn:language>

The `<autn:language>` tag specifies the language of the training text. This tag is optional.

<autn:reference>

The `<autn:reference>` tag specifies the IDOL `DREREFERENCE` to use for training. This tag is required if `<autn:type>` is `DREDOCUMENT`, and you do not set `<autn:docid>`.

NOTE: If the document is of the type `DREDOCUMENT`, you must set either `<autn:reference>` or `<autn:docid>`, but not both.

For more information, see <autn:type> and <autn:docid>.

<autn:docid>

The `<autn:docid>` tag specifies the IDOL `DocID` to use for training. This tag is required if `<autn:type>` is `DREDOCUMENT`, and you do not set `<autn:reference>`.

NOTE: If the document is of the type `DREDOCUMENT`, you must set either `<autn:reference>` or `<autn:docid>`, but not both.

For more information, see <autn:type> and <autn:reference>.

<autn:database>

The `<autn:database>` tag specifies the IDOL database in which the training document is located. You can set only one database for each `<autn:trainingelement>` tag. This tag is optional.

## <autn:simplecat>

The `<autn:simplecat>` tag specifies whether the category is a simple category. For example:

    <autn:simplecat>True</autn:simplecat>

NOTE: If you use this tag, do not set `<autn:relevancecat>`.

## <autn:relevancecat>

The `<autn:relevancecat>` tag specifies whether the category is a relevance category. For example:

    <autn:relevancecat>False</autn:relevancecat>

NOTE: If you use this tag, do not set `<autn:simplecat>.`

## <autn:details>

The `<autn:details>` tag sets training details for the category. You can include one set of `<autn:details>` within each set of `<autn:category>` tags.

The following table lists the tags that are allowed in `<autn:details>`.

Tag name | Number allowed | Required
--- | --- | ---
<autn:generatedterms> and <autn:generatedweights> | one | See below
<autn:queryagenttnw> | one | No
<autn:modifiedterms> and <autn:modifiedweights> | one | No
<autn:exclusions> | one | No
<autn:inclusions> | one | No
<autn:fakeweights> | one | No
<autn:numresults> | one | No
<autn:threshold> | one | No
<autn:databases> | one | No
<autn:fieldtext> | one | No
<autn:taxonomyroot> | one | No
<autn:active> | one | No
<autn:role> | one | No
<autn:memberpermissions> | one | No
<autn:nonmemberpermissions> | one | No
<autn:simplecatdefaultcat> | one | No
<autn:relevantcat> | one | No
<autn:simplecatparam> | one | No
<autn:userfields> | one | No

<autn:generatedterms>

The `<autn:generatedterms>` tag sets terms generated for a category from training. Do this only if you are editing an existing category from which you can take the terms. You can include one `<autn:generatedterms>` in each set of `<autn:details>` tags. For example:

    <autn:generatedterms>LYMPH,MISDIAGNOS,PATHOLOGI</autn:generatedterms>

NOTE: If you specify terms for a category in the `<autn:generatedterms>` tag, you must enter a corresponding list of weights by using the `<autn:generatedweights>` tag.

The `<autn:generatedterms>` tag is required if you set `<autn:queryagenttnw>`. For more information, see <autn:queryagenttnw>.

<autn:generatedweights>

The `<autn:generatedweights>` tag sets weights generated for the terms for the category from training. Do this only if you are editing an existing category from which you can take the weights. You can include one `<autn:generatedweights>` in each set of `<autn:details>` tags. For example:

    <autn:generatedweights>5960,4035,4001</autn:generatedweights>

NOTE: If you specify weights for a category in the `<autn:generatedweights>` tag, you must enter a corresponding list of terms by using the `<autn:generatedterms>` tag.

The `<autn:generatedweights>` tag is required if you set `<autn:queryagenttnw>`. For more information, see <autn:queryagenttnw>.

<autn:queryagenttnw>

The `<autn:queryagenttnw>` tag specifies the query string generated by terms and weights used to build the category. For example:

    <autn:queryagenttnw>LYMPH~[5960] MISDIAGNOS~[4305] PATHOLOGI~[4001]</autn:queryagenttnw>

NOTE: You can use `<autn:queryagenttnw>` with either `<autn:generatedterms>` and `<autn:generatedweights>`, or `<autn:modifiedterms>` and `<autn:modifiedweights>`. If both sets exist, modified terms take precedence over generated ones.

The `<autn:queryagenttnw>` tag performs the same function as the IDOL CategoryBuild action. See Build Categories.

For more information, see <autn:generatedterms>, <autn:generatedweights>, <autn:modifiedterms>, and <autn:modifiedweights>.

<autn:modifiedterms>

The `<autn:modifiedterms>` tag sets terms defined by the user. You can include one `<autn:modifiedterms>` within each set of `<autn:details>` tags. For example:

    <autn:modifiedterms>LYMPH,MISDIAGNOS,PATHOLOGI</autn:modifiedterms>

For more information on changing the weights of terms in a category, see Change Category Term Weights.

NOTE: If you specify terms for a category in the `<autn:modifiedterms>` tag, you must enter a corresponding list of weights by using the `<autn:modifiedweights>` tag.

<autn:modifiedweights>

The `<autn:modifiedweights>` tag sets weights for terms defined by the user. You can include one `<autn:modifiedweights>` within each set of `<autn:details>` tags. For example:

    <autn:modifiedweights>5960,4035,4001</autn:modifiedweights>

For more information on changing the weights of terms in a category, see Change Category Term Weights.

NOTE: If you specify weights for a category in the `<autn:modifiedweights>` tag, you must enter a corresponding list of terms by using the `<autn:modifiedterms>` tag.

<autn:exclusions>

A comma-separated list of documents to be excluded from category queries. For example:

    <autn:exclusions>C:\temp\doc1.txt,C:\temp\doc2.txt</autn:exclusions>

For more information, see the CategorySetSpecialDocs Exclusions parameter.

<autn:inclusions>

The `<autn:inclusions>` tag contains a comma-separated list of documents to be included in category queries. For example:

    <autn:inclusions>C:\temp\docA.txt,C:\temp\docB.txt</autn:inclusions>

For more information, see the CategorySetSpecialDocs Inclusions parameter.

NOTE: If you use this tag, you must set corresponding weights for the included terms with the `<autn:fakeweights>` tag.

<autn:fakeweights>

The `<autn:fakeweights>` tag contains a comma-separated list of weights for documents specified in `<autn:inclusions>`. Weights must correspond to the documents in number and order. For example:

    <autn:fakeweights>800,2200</autn:fakeweights>

For more information, see the CategorySetSpecialDocs FakeWeights parameter.

<autn:numresults>

The `<autn:numresults>` tag sets the maximum number of results that category queries can return. You can include one `<autn:numresults>` tag for each category within `<autn:details>` tags. For example:

    <autn:numresults>10</autn:numresults>

<autn:threshold>

The `<autn:threshold>` tag sets the minimum relevance score that documents must possess to appear in category query results. You can include one `<autn:threshold>` tag for each category within `<autn:details>` tags. For example:

    <autn:threshold>400</autn:threshold>

<autn:databases>

The `<autn:databases>` tag sets the databases in which documents must exist to appear in category query results. You must separate multiple databases with plus symbols, commas, or spaces. For example:

    <autn:databases>Archive,Minicar</autn:databases>

<autn:fieldtext>

The `<autn:fieldtext>` tag specifies the fields that result documents must contain, and the conditions that these fields have to meet for the documents to be returned as results.

For more information, see the CategorySetDetails FieldText parameter.

<autn:taxonomyroot>

The `<autn:taxonomyroot>` tag specifies whether the category is a taxonomy root. For example:

    <autn:taxonomyroot>True</autn:taxonomyroot>

<autn:active>

The `<autn:active>` tag specifies whether the category is active. For example:

    <autn:active>True</autn:active>

<autn:role>

The `<autn:role>` tag specifies the role or roles that you want to give access to the category. For example:

    <autn:role>Usertype1,Usertype2</autn:role>

Use <autn:memberpermissions> and <autn:nonmemberpermissions> to set which category access permissions members and non-members of this role should have.

<autn:memberpermissions>

The `<autn:memberpermissions>` tag sets the category access permissions that you want role members to have. If you want to list multiple permissions, you must separate them with commas. For example:

    <autn:memberpermissions>read,edit</autn:memberpermissions>

For more information, see the CategorySetPermissions MemberPermissions parameter.

<autn:nonmemberpermissions>

The `<autn:nonmemberpermissions>` tag sets the category access permissions that you want role non-members to have. If you want to list multiple permissions, you must separate them with commas. For example:

    <autn:nonmemberpermissions>read</autn:nonmemberpermissions>

For more information, refer to the CategorySetPermissions NonMemberPermissions parameter.

<autn:simplecatdefaultcat>

The `<autn:simplecatdefaultcat>` tag specifies which of the category's children is to be the default category for CategorySimpleCategorize. You must use the category ID value. For example:

    <autn:simplecatdefaultcat>1230982349874568</autn:simplecatdefaultcat>

For more information, see the CategorySetDetails SimpleCatDefaultCat parameter.

<autn:relevantcat>

The `<autn:relevantcat>` tag specifies which of the category's children is to be used as the relevant category. You must use the category ID value. For example:

    <autn:relevantcat>324987602</autn:relevantcat>

For more information, see the CategorySetDetails RelevantCat parameter.

<autn:simplecatparam>

The `<autn:simplecatparam>` tag sets a numeric factor that increases or decreases the probability of this category being chosen by the CategorySimpleCategorize action. For example:

    <autn:simplecatparam>1.4</autn:simplecatparam>

For more information, see the CategorySetDetails SimpleCatParam parameter.

<autn:userfields>

The `<autn:userfields>` tag sets fields and values defined by the user, as in this example:

    <autn:userfields>
    <autn:acc-inbox-threshold>30</autn:acc-inbox-threshold>
    </autn:userfields>

Copyright 2024 Open Text
Version 24.3 | Last updated June 2024

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to MFI-swpdl.idoldocsfeedback@opentext.com.

We appreciate your feedback!

Product: IDOL IDOL Category Component 24.3

Topic Title: <autn:category>