Appendixes > Category XML Format > XML Format

XML Format
This section lists and describes the tags that are allowed in the XML file from which you want to import a category structure.
You must include the <autn:categories> tag in the XML file; however, there are no required tags within <autn:categories>. If you only include the <autn:categories> tag, IDOL imports an empty category structure. To expand the category structure, use the <autn:category> tag and its children.
<autn:categories> (required)
Marks the beginning of the XML categories that IDOL server reads. When you use the CategoryImportFromXML action, IDOL server reads the XML within the opening and closing <autn:categories> tags.
All categories (<autn:category>) are children of (<autn:categories>) when you export a category from IDOL to XML. The XML then can be imported to IDOL. They should have the same format.
You must include an XML namespace in the tag. For example:
<autn:categories xmlns:autn="http://schemas.autonomy.com/aci">
 
<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 within the <autn:categories> tag, and <autn:category> tags may also contain child <autn:category> tags.
These tags are allowed within <autn:category>:
 
<autn:name> (required)
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>
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 in IDOL online help.
<autn:parent>
Identifies the ID of the parent category. This option is only effective if you set flat=true.
For further information, see the CategoryImportFromXML Flat parameter in IDOL online help.
<autn:refersto>
Identifies the ID of the category to which the new category refers. This is used to create a category which refers to another, inheriting its fields, training, and special documents. This option is only effective if you set flat=true.
For further information, see the CategoryImportFromXML Flat parameter in IDOL online help.
<autn:trainingelement>
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 within each set of <autn:category> tags.
These tags are allowed within <autn:trainingelement>:
 
<autn:type>
Sets the type of training to be used by <autn:trainingelement>. Each <autn:trainingelement> may contain only one <autn:type> tag.
These values are valid for <autn:type>:
:
Identifies the training type as Boolean. The Boolean operator must be defined in the <autn:content> tag, as in this example:
Identifies the training type as a document indexed in IDOL. The document is specified by either autn:reference or autn:docid.
<autn:content>
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>
Specifies the language of the training text. This tag is optional.
<autn:reference>
Specifies the IDOL DREREFERENCE to use for training. This tag is required if <autn:type> is DREDOCUMENT and <autn:docid> is not set.
 
NOTE If the document is of the type DREDOCUMENT, you must set either this tag or <autn:docid>, but not both.
For more information, see <autn:type> and <autn:docid>.
<autn:docid>
Specifies the IDOL DocID to use for training. This tag is required if <autn:type> is DREDOCUMENT and <autn:reference> is not set.
 
NOTE If the document is of the type DREDOCUMENT, you must set either this tag or <autn:reference>, but not both.
For more information, see <autn:type> and <autn:reference>.
<autn:database>
Specifies the IDOL database in which the training document is located. You can only set one database per <autn:trainingelement> tag. This tag is optional.
<autn:simplecat>
Specifies whether or not 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>
Specifies whether or not 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>
Sets training details for the category. You can include one set of <autn:details> within each set of <autn:category> tags.
These tags are allowed within <autn:details>:
 
<autn:generatedterms>
Sets terms generated for a category from training – only do this if you are editing an existing category from which you can take the terms. You can include one <autn:generatedterms> within each set of <autn:details> tags, as in this example:
<autn:generatedterms>LYMPH,MISDIAGNOS,PATHOLOGI</autn:generatedterms>
 
NOTE If you are specifying terms for a category through <autn:generatedterms>, you must enter a corresponding list of weights with <autn:generatedweights> tags.
This tag is required if you set <autn:queryagenttnw>. For more information, see <autn:queryagenttnw>.
<autn:generatedweights>
Sets weights generated for a category’s terms from training. Do this if only you are editing an existing category from which you can take the weights. You can include one <autn:generatedweights> within each set of <autn:details> tags. For example:
<autn:generatedweights>5960,4035,4001</autn:generatedweights>
 
NOTE If you are specifying weights for a category using <autn:generatedweights>, you must enter a corresponding list of terms with <autn:generatedterms> tags.
This tag is required if you set <autn:queryagenttnw>. For more information, see <autn:queryagenttnw>.
<autn:queryagenttnw>
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>. In the case that both sets exist, modified terms take precedence over generated ones.
This tag performs the same function as the IDOL CategoryBuild action command. For more information, refer to the IDOL Server Administration Guide.
For more information, see <autn:generatedterms>, <autn:generatedweights>, <autn:modifiedterms>, and <autn:modifiedweights>.
<autn:modifiedterms>
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, refer to the IDOL server Administration Guide.
 
NOTE If you are specifying terms for a category using <autn:modifiedterms>, you must enter a corresponding list of weights with <autn:modifiedweights> tags.
<autn:modifiedweights>
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, refer to the IDOL server Administration Guide.
 
NOTE If you are specifying weights for a category using <autn:modifiedweights>, you must enter a corresponding list of terms with <autn:modifiedterms> tags.
<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 in IDOL online help.
<autn:inclusions>
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 in IDOL online help.
 
NOTE If you use this tag, you must set corresponding weights for the included terms with the <autn:fakeweights> tag.
<autn:fakeweights>
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 in IDOL online help.
<autn:numresults>
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>
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>
Sets the databases in which documents must exist to appear in category query results. Multiple databases must be separated by plus symbols, commas, or spaces. For example:
<autn:databases>Archive,Minicar</autn:databases>
<autn:fieldtext>
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 CategorySetFields Fieldtext parameter in IDOL online help.
<autn:taxonomyroot>
Specifies whether or not the category is a taxonomy root. For example:
<autn:taxonomyroot>true</autn:taxonomyroot>
<autn:active>
Specifies whether or not the category is active. For example:
<autn:active>true</autn:active>
<autn:role>
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>
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 in IDOL online help.
<autn:nonmemberpermissions>
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, see the CategorySetPermissions NonMemberPermissions parameter in IDOL online help.
<autn:simplecatdefaultcat>
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 in IDOL online help.
<autn:relevantcat>
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 in IDOL online help.
<autn:simplecatparam>
Sets a numeric factor that increases or decreases the probability of this category being chosen by the CategorySimpleCategorize action command. For example:
<autn:simplecatparam>1.4</autn:simplecatparam>
For more information, see the CategorySetDetails SimpleCatParam parameter in IDOL online help.
<autn:userfields>
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>