How to read AFS Configuration Options - AFS

AFS Configuration Options

Product
AFS
AFS_Version
7.7
Category
Reference Guide

Each option is described in a table:

Option

Type (default)

Description

Role

Editable in Back Office

Name of the Option as entered in the conf.xml file.

Type of the Option (the default value of this option).

Description of what the option does and how to activate it

Role required to edit the Option through the Configuration Application of the Back Office.

Information whether or not the Option can be edited from the Back Office

Tip: It is recommended to use the Configuration Application of the Back Office to edit Query Engine and Pipes and Filters configurations.

The namespace to use in conf.xml files is: http://ref.antidot.net/v7/afs#

To get the XPath of the option, it is necessary to concatenate the prefix at the beginning of the table and the value of the column Option XPath for a particular option.

The type of the option can be:

  • string
  • string_list
  • string_map
  • uint
  • double
  • bool

The value of the parameter is written in the last node of the XPath of the option. A short description helps finding the corresponding option when needed.

The default value gives the behavior of the option when it is not declared in the conf.xml file.

Hereafter a conf.xml file example:

<?xml version="1.0" encoding="iso-8859-1" standalone="yes"?>
<afs:conf xmlns:afs="http://ref.antidot.net/v7/afs#">
    <afs:PaF>
        <afs:Filters>
            <afs:initGraceTime value="600"/>
            <afs:Index>
                <afs:Limits>
                    <afs:title value="1024"/>
                </afs:Limits>
            </afs:Index>
        </afs:Filters>
        <afs:Analyzers>
            <afs:Thesaurus>
                <afs:WordLimits>
                    <afs:warning value="10"/>
                    <afs:discard value="50"/>
                </afs:WordLimits>
            </afs:Thesaurus>
        </afs:Analyzers>
        <afs:Perimeter>
            <afs:defaultRule value="true"/>
            <afs:Rules>
                <afs:mapItem key="*from*" value="false"/>
                <afs:mapItem key="*browser*" value="false"/>
             </afs:Rules>
        </afs:Perimeter>
    </afs:PaF>
</afs:conf>