|
CloudView Configuration Reference
|
| Name | Type | Default value | Description |
| name | string | - | Name of this Data Model. |
| defaultClass | string | - | Default class to push documents when there is no "datamodel_class" papi directive, or no "TYPE" meta. Usually, all data model classes generate type-prefixed field names, like 'myclass_myproperty', except the defaultClass which has unprefixed fields in the expansion. The analysis pipeline deduces the data model class of a document by applying the following rules with this specific order:
|
| possibleLanguages | string | - | The list of languages that can appear in the corpus. Language detection will be restricted to this set. A null value means that all languages are possible. |
| storeAllMetas (UI: Store all unprocessed metas) |
boolean | False | Saves all metas that were not mapped to an index field or category as "csv encoded metas". These metas are retrievable only. To make a meta searchable, create a data model property for it. |
| traceAllMetas (UI: Trace all metas) |
boolean | False | Select this option before indexing, then click "Add Properties from Traced Metas" to simplify creating new properties. The traced metas are stored in a separate database. Once you have created properties based on traced metas, de-select this option to prevent the database from growing unnecessarily over time. Trace all metas pushed by connectors in order to ease property configuration. |
| expandNamedEntitiesLikeIn2014 | boolean | False |
| Type | Wrapper | Description |
| DataModelClass* | - | List of classes of this data model. |
| DataModelEnum* | - | |
| SemanticType* | - | The list of semantic types of this data model. A semantic type defines the semantic analysis to perform, and can be assigned to 'alphanumeric' properties. The semantic types available out of the box are: text, identifier, meta, and url. |
| Name | Type | Default value | Description |
| name | string | - | |
| parentClass | string | - | The parent class name. May be null if this class has no parent class. |
| Type | Wrapper | Description |
| DynamicProperty* | - | The dynamic properties of the class. |
| ExpansionParams | - | |
| Label* | - | Labels for i18n. TODO not implemented |
| Property* | - | The properties of the class. |
| Name | Type | Default value | Description |
| storeMetaNames | boolean | False | Stores the meta name associated to each value, in the resulting index field (or category facet or output context). This is useful to search and retrieve specific metas within the field. If 'Store meta names' is not selected for a dynamic property, the resulting index field (or category facet or output context) is the same as any other alphanumerical or numerical field created with standard properties: it contains only meta values. |
| Type | Wrapper | Description |
| MatchingRule* | - | List of rules to define which document metas should be mapped to this dynamic property. |
| Property | - | All property attributes apply to this dynamic property. |
| Name | Type | Default value | Description |
| pattern | string | - | If null, property name is used |
| mode | enum(prefix, suffix, substring, pattern, exact) | ||
| unprefix | boolean | False |
| Name | Type | Default value | Description |
| overrideClassExpansionParams | boolean | False | |
| dedicatedField | boolean | True | Should we create a dedicated index field for this property, or use a multi-field encoding? A dedicated field is recommended if more than a few percent of objects have this property. Internal: if there is no dedicated field, we store in the "metas" field and index using prefixed-words. |
| dynamicProperty | string | - | Storing this meta in a dynamical property decreases index's memory footprint and improve index's commit time. Faceting and sorting performances will be impacted (slower). |
| searchable (UI: Searchable) |
boolean | True | Allows users to search for matches in this property using a prefix. For example, to search for "API" in the title of a document, enter the search query <pre>title:API</pre> |
| retrievable (UI: Retrievable) |
boolean | True | Displays the meta in the hit content of search results. If the property doesn't have a dedicated field, the value will be CSV-encoded in the 'metas' field. |
| ramBased (UI: RAM based) |
boolean | False | Stores this property in RAM. Use this option if you need to:
Only the "retrievable" part of the property is stored in RAM. |
| facet | boolean | False | Creates a navigation facet from the property values. |
| disjunctiveRefines (UI: Disjunctive refines) |
boolean | False | Makes refinements on this facet disjunctive ("checkboxes") rather than exclusive (select one). |
| defaultValue | string | - | If there is no value for this property in the document, use this default value. |
| additionalMetaNames | string | - | Maps these metas (as a comma-separated list) to this index or facet field. Usable only for properties having a dedicated field, a facet, or are searchable without prefix. |
| arity (UI: Cardinality) |
enum(zero_or_one, one, many) | zero_or_one | The arity of the property (zero_or_one, one, many) {@code enum(zero_or_one, one, many)} |
| name | string | - | Property name |
| comment | string | - | Optional comment to explain property use. |
| semanticType | string | - | Defines how the text is processed and indexed (tokenization, normalization and indexing-time semantic processing). This value must refer to a valid !SemanticType object in the DataModel. |
| indexInTextField | boolean | False | Allows users to search for matches in this property without using a prefix, by mapping the values to the
generic "text" index field, as invisible text. For example, to search for "API" in a document, enter the search query <pre>API</pre> |
| queryExpansionConfig | string | - | Search-time query expansion config to use for this property. This follows the 'QEC' format specification. |
| enumerated | boolean | False | Is there a controlled and limited set of values for this property? Enumerated properties are indexed using a specific "Value" field, which stores entire values in an optimized way. Thus, performing faceting on this kind of field is faster than on a category field. It is not possible to perform any semantic processing on value fields. |
| Type | Wrapper | Description |
| KeyValue* | tags | User-defined tags for this property. This can be used for example to implement 6W faceting of the data model. |
| AdvancedParams | - | |
| KeyValue* | - | |
| Label* | - | Labels for the internationalization of this property's name |
| Name | Type | Default value | Description |
| generateAnalysis (UI: Generate analysis config) |
boolean | True | Creates the required mappings and document processors for this property. Only set this option to "false" to take complete control over analysis expansion for this property. |
| generateIndexSchema (UI: Generate index schema) |
boolean | True | Creates the required index fields for this property. Only set this option to "false" to take complete control over index schema expansion for this property. |
| generatePrefix (UI: Generate prefix handler) |
boolean | True | Creates a prefix handler in the search logics for this property. Only set this option to "false" to take complete control over query prefix handler expansion for this property. |
| generateFacet (UI: Generate category facet) |
boolean | True | Creates a category facet in the search logics for this property. Only set this option to "false" to take complete control over facet config expansion for this property. |
| generateMeta (UI: Generate hit meta) |
boolean | True | Creates a hit meta in the search logics for this property. Only set this option to "false" to take complete control over meta expansion for this property. |
| expandedPipelines | string | - | A comma-separated list of analysis pipelines to generate mappings and document processors on. If empty, generate on all pipelines. |
| expandedSearchLogics | string | - | A comma-separated list of search logics to generate prefix handlers, facets and hit metas on. If empty, generate on all search logics. |
| facetSortFunction | string | count | Sorting method if a category facet is created for this property. Select "ReverseSort" to reverse the sorting order. |
| facetReverseSort | boolean | False | Reverse sorting order if a category facet is created for this property. |
| facetExplicitSortOrderValues (UI: Explicit order) |
string | - | Ordered list of values used for explicit sort, comma-separated (use the backslash to escape a comma). |
| facetInHits (UI: Use for hit content) |
boolean | True | Displays this property in the hits content (if a category facet is created). |
| facetInNavigation (UI: Use for navigation) |
boolean | True | Displays this property in the navigation (if a category facet is created). |
| facetRoot (UI: Override root path) |
string | - | Replaces the default facet root path (Top/ClassProperties/<Property name>) (if a category facet is created). |
| categoryField (UI: Override field) |
string | - | Replaces the category field for this property (if a category facet is created). |
| categoryFacetMaxPerLevel (UI: Max. values) |
int | 100 | Displays a maximum of N values per level for this property (if a category facet is created). |
| facetMaxInHits | int | 100 | Displays a maximum of N values for this property (if a category facet is created). |
| numericalBits (UI: Bits for numerical value) |
int | 63 | Number of bits used to store a numerical value. |
| doublePrecision | int | 4 | Number of figures after the decimal point (if this is a double property). |
| enableTrustedQueries (UI: Trusted queries support) |
boolean | False | Precomputes the indexing of prefixes for the Trusted Queries widget. |
| dateInputFormat | string | - | Specifies an input format for DateFormatter for numerical properties with date or date_time type |
| dateOutputFormat | string | - | Specifies an output format for numerical properties with date or date_time type, used in full hits |
| gzip | boolean | True | Activates content compression (if an alphanum field is created) |
| unit | string | - | Unit Of Measurement in which the value is stored |
| patternSearchEnabled | boolean | False | Calculates additional dictionaries to perform pattern search within words (native prefix, suffix, substring search using #anumpattern) without relying on pattern expansion. This has a very high cost in indexing time and indexing size. Do not select unless advised by Exalead teams. |
| patternSearchOptimizationType | enum(ngramv1, ngramv2) | ngramv1 | Select algorithm based on dictionary ngrams or indexed ngrams (untokenized text only). |
| forcedRankToTextMapping | nullableint | Sets the ranking value for chunks in mapping to text field. -1 means that the chunk internal ranking value is kept. |
|
| detectTitle | boolean | False | Detect words set after # in path and use them as title |
| Name | Type | Default value | Description |
| facetSortFunction | string | count | Sorting method if a category facet is created for this property. Select "ReverseSort" to reverse the sorting order. |
| facetReverseSort | boolean | False | Reverse sorting order if a category facet is created for this property. |
| facetExplicitSortOrderValues (UI: Explicit order) |
string | - | Ordered list of values used for explicit sort, comma-separated (use the backslash to escape a comma). |
| facetInHits (UI: Use for hit content) |
boolean | True | Displays this property in the hits content (if a category facet is created). |
| facetInNavigation (UI: Use for navigation) |
boolean | True | Displays this property in the navigation (if a category facet is created). |
| facetRoot (UI: Override root path) |
string | - | Replaces the default facet root path (Top/ClassProperties/<Property name>) (if a category facet is created). |
| categoryField (UI: Override field) |
string | - | Replaces the category field for this property (if a category facet is created). |
| categoryFacetMaxPerLevel (UI: Max. values) |
int | 100 | Displays a maximum of N values per level for this property (if a category facet is created). |
| facetMaxInHits | int | 100 | Displays a maximum of N values for this property (if a category facet is created). |
| numericalBits (UI: Bits for numerical value) |
int | 63 | Number of bits used to store a numerical value. |
| doublePrecision | int | 4 | Number of figures after the decimal point (if this is a double property). |
| enableTrustedQueries (UI: Trusted queries support) |
boolean | False | Precomputes the indexing of prefixes for the Trusted Queries widget. |
| dateInputFormat | string | - | Specifies an input format for DateFormatter for numerical properties with date or date_time type |
| dateOutputFormat | string | - | Specifies an output format for numerical properties with date or date_time type, used in full hits |
| gzip | boolean | True | Activates content compression (if an alphanum field is created) |
| unit | string | - | Unit Of Measurement in which the value is stored |
| patternSearchEnabled | boolean | False | Calculates additional dictionaries to perform pattern search within words (native prefix, suffix, substring search using #anumpattern) without relying on pattern expansion. This has a very high cost in indexing time and indexing size. Do not select unless advised by Exalead teams. |
| patternSearchOptimizationType | enum(ngramv1, ngramv2) | ngramv1 | Select algorithm based on dictionary ngrams or indexed ngrams (untokenized text only). |
| forcedRankToTextMapping | nullableint | Sets the ranking value for chunks in mapping to text field. -1 means that the chunk internal ranking value is kept. |
|
| detectTitle | boolean | False | Detect words set after # in path and use them as title |
| generateAnalysis (UI: Generate analysis config) |
boolean | True | Creates the required mappings and document processors for this property. Only set this option to "false" to take complete control over analysis expansion for this property. |
| generateIndexSchema (UI: Generate index schema) |
boolean | True | Creates the required index fields for this property. Only set this option to "false" to take complete control over index schema expansion for this property. |
| generatePrefix (UI: Generate prefix handler) |
boolean | True | Creates a prefix handler in the search logics for this property. Only set this option to "false" to take complete control over query prefix handler expansion for this property. |
| generateFacet (UI: Generate category facet) |
boolean | True | Creates a category facet in the search logics for this property. Only set this option to "false" to take complete control over facet config expansion for this property. |
| generateMeta (UI: Generate hit meta) |
boolean | True | Creates a hit meta in the search logics for this property. Only set this option to "false" to take complete control over meta expansion for this property. |
| expandedPipelines | string | - | A comma-separated list of analysis pipelines to generate mappings and document processors on. If empty, generate on all pipelines. |
| expandedSearchLogics | string | - | A comma-separated list of search logics to generate prefix handlers, facets and hit metas on. If empty, generate on all search logics. |
| generateFromSeparateMetas | boolean | False | Content generated by several metas |
| firstCoordinateMeta | string | - | This meta will be used to define the first coordinate of the point |
| secondCoordinateMeta | string | - | This meta will be used to define the second coordinate of the point |
| Name | Type | Default value | Description |
| facetSortFunction | string | count | Sorting method if a category facet is created for this property. Select "ReverseSort" to reverse the sorting order. |
| facetReverseSort | boolean | False | Reverse sorting order if a category facet is created for this property. |
| facetExplicitSortOrderValues (UI: Explicit order) |
string | - | Ordered list of values used for explicit sort, comma-separated (use the backslash to escape a comma). |
| facetInHits (UI: Use for hit content) |
boolean | True | Displays this property in the hits content (if a category facet is created). |
| facetInNavigation (UI: Use for navigation) |
boolean | True | Displays this property in the navigation (if a category facet is created). |
| facetRoot (UI: Override root path) |
string | - | Replaces the default facet root path (Top/ClassProperties/<Property name>) (if a category facet is created). |
| categoryField (UI: Override field) |
string | - | Replaces the category field for this property (if a category facet is created). |
| categoryFacetMaxPerLevel (UI: Max. values) |
int | 100 | Displays a maximum of N values per level for this property (if a category facet is created). |
| facetMaxInHits | int | 100 | Displays a maximum of N values for this property (if a category facet is created). |
| numericalBits (UI: Bits for numerical value) |
int | 63 | Number of bits used to store a numerical value. |
| doublePrecision | int | 4 | Number of figures after the decimal point (if this is a double property). |
| enableTrustedQueries (UI: Trusted queries support) |
boolean | False | Precomputes the indexing of prefixes for the Trusted Queries widget. |
| dateInputFormat | string | - | Specifies an input format for DateFormatter for numerical properties with date or date_time type |
| dateOutputFormat | string | - | Specifies an output format for numerical properties with date or date_time type, used in full hits |
| gzip | boolean | True | Activates content compression (if an alphanum field is created) |
| unit | string | - | Unit Of Measurement in which the value is stored |
| patternSearchEnabled | boolean | False | Calculates additional dictionaries to perform pattern search within words (native prefix, suffix, substring search using #anumpattern) without relying on pattern expansion. This has a very high cost in indexing time and indexing size. Do not select unless advised by Exalead teams. |
| patternSearchOptimizationType | enum(ngramv1, ngramv2) | ngramv1 | Select algorithm based on dictionary ngrams or indexed ngrams (untokenized text only). |
| forcedRankToTextMapping | nullableint | Sets the ranking value for chunks in mapping to text field. -1 means that the chunk internal ranking value is kept. |
|
| detectTitle | boolean | False | Detect words set after # in path and use them as title |
| generateAnalysis (UI: Generate analysis config) |
boolean | True | Creates the required mappings and document processors for this property. Only set this option to "false" to take complete control over analysis expansion for this property. |
| generateIndexSchema (UI: Generate index schema) |
boolean | True | Creates the required index fields for this property. Only set this option to "false" to take complete control over index schema expansion for this property. |
| generatePrefix (UI: Generate prefix handler) |
boolean | True | Creates a prefix handler in the search logics for this property. Only set this option to "false" to take complete control over query prefix handler expansion for this property. |
| generateFacet (UI: Generate category facet) |
boolean | True | Creates a category facet in the search logics for this property. Only set this option to "false" to take complete control over facet config expansion for this property. |
| generateMeta (UI: Generate hit meta) |
boolean | True | Creates a hit meta in the search logics for this property. Only set this option to "false" to take complete control over meta expansion for this property. |
| expandedPipelines | string | - | A comma-separated list of analysis pipelines to generate mappings and document processors on. If empty, generate on all pipelines. |
| expandedSearchLogics | string | - | A comma-separated list of search logics to generate prefix handlers, facets and hit metas on. If empty, generate on all search logics. |
| maxBlockSize | int | 24 | Maximum number of objects in lookup structure leaves. |
| precision | int | 6 | The number of decimals that will be used in geometrical representations and computations. |
| bboxSuffix | string | _bbox | Meta name suffix for BBox. |
| Name | Type | Default value | Description |
| language | string | - | Label language |
| value | string | - | Label value |
| Name | Type | Default value | Description |
| overrideClassExpansionParams | boolean | False | |
| dedicatedField | boolean | True | Should we create a dedicated index field for this property, or use a multi-field encoding? A dedicated field is recommended if more than a few percent of objects have this property. Internal: if there is no dedicated field, we store in the "metas" field and index using prefixed-words. |
| dynamicProperty | string | - | Storing this meta in a dynamical property decreases index's memory footprint and improve index's commit time. Faceting and sorting performances will be impacted (slower). |
| searchable (UI: Searchable) |
boolean | True | Allows users to search for matches in this property using a prefix. For example, to search for "API" in the title of a document, enter the search query <pre>title:API</pre> |
| retrievable (UI: Retrievable) |
boolean | True | Displays the meta in the hit content of search results. If the property doesn't have a dedicated field, the value will be CSV-encoded in the 'metas' field. |
| ramBased (UI: RAM based) |
boolean | False | Stores this property in RAM. Use this option if you need to:
Only the "retrievable" part of the property is stored in RAM. |
| facet | boolean | False | Creates a navigation facet from the property values. |
| disjunctiveRefines (UI: Disjunctive refines) |
boolean | False | Makes refinements on this facet disjunctive ("checkboxes") rather than exclusive (select one). |
| defaultValue | string | - | If there is no value for this property in the document, use this default value. |
| additionalMetaNames | string | - | Maps these metas (as a comma-separated list) to this index or facet field. Usable only for properties having a dedicated field, a facet, or are searchable without prefix. |
| arity (UI: Cardinality) |
enum(zero_or_one, one, many) | zero_or_one | The arity of the property (zero_or_one, one, many) {@code enum(zero_or_one, one, many)} |
| name | string | - | Property name |
| comment | string | - | Optional comment to explain property use. |
| type | enum(integer, double, date, date_time, point_geo, point_xy, unsigned, measure) | Type of this numerical property. Depending on the type, additional validation and formating will be performed on the value. Valid values are:
|
| Type | Wrapper | Description |
| KeyValue* | tags | User-defined tags for this property. This can be used for example to implement 6W faceting of the data model. |
| AdvancedParams | - | |
| KeyValue* | - | |
| Label* | - | Labels for the internationalization of this property's name |
| Name | Type | Default value | Description |
| overrideClassExpansionParams | boolean | False | |
| dedicatedField | boolean | True | Should we create a dedicated index field for this property, or use a multi-field encoding? A dedicated field is recommended if more than a few percent of objects have this property. Internal: if there is no dedicated field, we store in the "metas" field and index using prefixed-words. |
| dynamicProperty | string | - | Storing this meta in a dynamical property decreases index's memory footprint and improve index's commit time. Faceting and sorting performances will be impacted (slower). |
| searchable (UI: Searchable) |
boolean | True | Allows users to search for matches in this property using a prefix. For example, to search for "API" in the title of a document, enter the search query <pre>title:API</pre> |
| retrievable (UI: Retrievable) |
boolean | True | Displays the meta in the hit content of search results. If the property doesn't have a dedicated field, the value will be CSV-encoded in the 'metas' field. |
| ramBased (UI: RAM based) |
boolean | False | Stores this property in RAM. Use this option if you need to:
Only the "retrievable" part of the property is stored in RAM. |
| facet | boolean | False | Creates a navigation facet from the property values. |
| disjunctiveRefines (UI: Disjunctive refines) |
boolean | False | Makes refinements on this facet disjunctive ("checkboxes") rather than exclusive (select one). |
| defaultValue | string | - | If there is no value for this property in the document, use this default value. |
| additionalMetaNames | string | - | Maps these metas (as a comma-separated list) to this index or facet field. Usable only for properties having a dedicated field, a facet, or are searchable without prefix. |
| arity (UI: Cardinality) |
enum(zero_or_one, one, many) | zero_or_one | The arity of the property (zero_or_one, one, many) {@code enum(zero_or_one, one, many)} |
| name | string | - | Property name |
| comment | string | - | Optional comment to explain property use. |
| type | enum(Planar) | Coordinate system of this geo property. For now, only cartesian/planar systems are supported. |
| Type | Wrapper | Description |
| KeyValue* | tags | User-defined tags for this property. This can be used for example to implement 6W faceting of the data model. |
| AdvancedParams | - | |
| KeyValue* | - | |
| Label* | - | Labels for the internationalization of this property's name |
| Name | Type | Default value | Description |
| arity (UI: Cardinality) |
enum(zero_or_one, one, many) | zero_or_one | The arity of the property (zero_or_one, one, many) {@code enum(zero_or_one, one, many)} |
| name | string | - | Property name |
| comment | string | - | Optional comment to explain property use. |
| type | string | - | Name of the related DataModelClass |
| generateInnerjoinKey | boolean | False | NOT IMPLEMENTED. Generates a field that can be used for performing INNERJOIN between this property and its class. Note that doing this incurs a memory cost. |
| storeIdentifier | boolean | False | Stores the unique identifiers of the property values for further retrieval. |
| Name | Type | Default value | Description |
| arity (UI: Cardinality) |
enum(zero_or_one, one, many) | zero_or_one | The arity of the property (zero_or_one, one, many) {@code enum(zero_or_one, one, many)} |
| name | string | - | Property name |
| comment | string | - | Optional comment to explain property use. |
| type | string | - | Name of the related DataModelEnum. |
| disjunctiveRefines | boolean | False | Are refinements on this facet disjunctive ("checkboxes") or exclusive (select one)? |
| Name | Type | Default value | Description |
| generateAnalysis (UI: Generate analysis config) |
boolean | True | Creates the required mappings and document processors for this property. Only set this option to "false" to take complete control over analysis expansion for this property. |
| generateIndexSchema (UI: Generate index schema) |
boolean | True | Creates the required index fields for this property. Only set this option to "false" to take complete control over index schema expansion for this property. |
| generatePrefix (UI: Generate prefix handler) |
boolean | True | Creates a prefix handler in the search logics for this property. Only set this option to "false" to take complete control over query prefix handler expansion for this property. |
| generateFacet (UI: Generate category facet) |
boolean | True | Creates a category facet in the search logics for this property. Only set this option to "false" to take complete control over facet config expansion for this property. |
| generateMeta (UI: Generate hit meta) |
boolean | True | Creates a hit meta in the search logics for this property. Only set this option to "false" to take complete control over meta expansion for this property. |
| expandedPipelines | string | - | A comma-separated list of analysis pipelines to generate mappings and document processors on. If empty, generate on all pipelines. |
| expandedSearchLogics | string | - | A comma-separated list of search logics to generate prefix handlers, facets and hit metas on. If empty, generate on all search logics. |
| Name | Type | Default value | Description |
| name | string | - | |
| strict | boolean | False | If strict, this data type will only accept values listed in elements. Warning: This is not implemented for the moment. |
| defaultValue | int | -1 | Index of default value in the elements list. -1 = no default value for property |
| Type | Wrapper | Description |
| DataModelEnumElement* | - | Possible values for the enum. |
| Label* | - | Labels for i18n. TODO not implemented |
| Name | Type | Default value | Description |
| name | string | - |
| Type | Wrapper | Description |
| Label* | - | Labels for i18n. TODO not implemented |
| Name | Type | Default value | Description |
| name | string | - | Name for this type, to be used in the "type" field of the AlphanumProperty. |
| extraContexts | string | - | Extra analysis contexts (not datamodel-controlled) on which this text type must be applied. |
| tokenize (UI: Tokenize) |
boolean | True | Splits phrases into individual words or tokens. Required for index-time semantic processing. |
| urlProcessing (UI: Process as an URL) |
boolean | False | Creates 3 prefix handlers for this property, for the 'site', 'url', and 'inurl' features. |
| indexNormalized (UI: Index as normalized) |
boolean | True | Indexes CaFé as cafe. |
| indexLowercase (UI: Index as lowercase) |
boolean | False | Indexes CaFé as café |
| indexExact (UI: Index as exact) |
boolean | False | Indexes CaFé as CaFé |
| indexSeparators (UI: Index separators) |
boolean | True | Indexes the position of separators to enable search within a string. Select this option when using the "split" type prefix handler. |
| detectLanguage (UI: Detect language) |
boolean | True | Determines the language of a document by analyzing its text. Required for extracting spell check ngrams, phonetic forms, named entities and related terms. For performance reasons, only select this option if the documents to be pushed do not already include a 'language' meta. Selecting this option creates a meta called 'language', as well as a Language facet for search results display in the Refinements panel. |
| extractWords (UI: Extract words) |
boolean | True | Extracts the words of each document to the dictionary targeted by this semantic type. |
| extractNamedEntities (UI: Extract named entities) |
boolean | False | Flags famous people, places, organizations or events, and annotates the corresponding index field with the prefix NE:<entity type>. This option adds:
|
| extractRelatedTerms (UI: Extract related terms) |
boolean | False | Finds important concepts within the corpus and stores them in the dictionary targeted by this semantic type. To display related terms in the Refinements panel of your search application, you must enable them through the search logics. This option adds a Related Terms Extractor processor to the semantic analysis pipeline. |
| extractSpellCheckNGrams (UI: Extract spell check ngrams) |
boolean | False | Calculates probability of word occurrences or word phrases within the corpus and stores them in the dictionary targeted by this semantic type. This significantly improves the effectiveness of spell-checking. This option adds a NGrams Extractor processor to the semantic analysis pipeline. |
| extractPhoneticForms (UI: Extract phonetic forms) |
boolean | False | Creates a phonetic version for each word and stores them in the dictionary targeted by this semantic type. This significantly improves the effectiveness of spell check and enables phonetic search (for example, soundslike: exaleed). This option adds a Phonetizer processor to the semantic analysis pipeline. |
| tokenizationConfig (UI: Tokenization config) |
string | - | Defines the tokenization config to use for analysis and search. Found in the linguistic configuration. |
| rankForDedicatedMapping | long | 4 | Ranking value for the mapping to a dedicated index field. |
| rankForTextMapping | long | 3 | Ranking value for the mapping to the "text" index field. |
| dictionaryName (UI: Dictionary) |
string | - | A dictionary is a structure separated from the index, that stores all the words of an indexed document, and their number of occurrences in the corpus. It's used for linguistic expansion mechanisms such as spell-checking or regular expression matching. If value is "_None_", words will not be stored in a dictionary. In admin-ui, select "None" if you want this behavior. |
| Type | Wrapper | Description |
| KeyValue* | - | Custom parameters. |
| Type | Wrapper | Description |
| Connector* | - | List of connectors. |
| Name | Type | Default value | Description |
| name | string | - | The name of the connector. |
| classId | string | - | Connector class identifier. This identifies the kind of data source this connectors connects to, as well as the actual implementation. The class identifier can be a reference to an exascript class, a Java class or a .NET Class. This attribute must be null for unmanaged connectors. The value provided should be one of the values returned by @see listConnectorTypes. |
| customClassId | string | - | Implementation class identifier. Optional. Can be used to specify a custom implementation of the connector. |
| managed | boolean | False | Indicates that the connector is managed by a framework. A managed connector is launched and operated as a CloudView service, whereas an 'unmanaged connector' is handled by a third-party process. |
| connectorServer | string | - | Defines the connector server hosting this connector. For managed connectors only. Connectors are deployed in a connector server. There are 3 kinds of connector server: exascript, Java or .NET. The value of this attribute should refer to a connector server defined in the deployment configuration (for example, exa0, java0, dotnet0). |
| buildGroup | string | - | Defines the build group that will receive the documents. For managed connectors only. For a single connector server, different connectors can push to different build groups. |
| pushAPIServer | string | - | Defines the Push API server that will receive the documents. For managed connectors only. For a single connector server, different connectors can push to different Push API servers. |
| authenticationMode | enum(public, basic) | public | The connector configuration parameters. Connector parameters such as the data sources or folders to actually index in the data source are provided as key-values. No configuration parameters should be provided for unmanaged connectors. The set of meta data to be automatically added to indexed documents. These meta-data items are inserted into each document from this connector when analyzing the document. Connector authentication mode values are: public and basic.If set to basic, the indexing-server will require authentication
to push content with this connector name. |
| login | string | - | User login if authenticationMode parameter is set to basic. |
| password | string | - | User password if authenticationMode parameter is set to basic. |
| defaultDataModelClass | string | - | Specifies the class in which the documents should be indexed if the connector does not provide a dataModelClass indication for its documents. The default value (null) means that the documents will go in the default class of the DataModel. |
| documentsType | string | - | Type of documents produced by this source. The type of documents must match one of the types declared in your CloudView license file. |
| generated | boolean | False | Has this connector been generated automatically by another component or it has been manually added by the user. A generated connector must be configured by the component that has generated it and won't be editable in admin-ui |
| Type | Wrapper | Description |
| KeyValue* | config | |
| KeyValue* | forcedMeta | |
| ConnectorScheduledScan* | - | List of scheduled scans for the connector. |
| PostProcessingPipeline | - | Pipeline post-processing documents sent by this connector. |
| PushConfig | - | Specifies how documents are sent to the indexing-server. |
| SourceCachingConfig | - | |
| SourceFetchConfig | - | |
| SourcePreviewConfig | - | |
| SourceThumbnailsConfig | - |
| Name | Type | Default value | Description |
| scanMode | string | - | The scan mode to trigger. |
| Type | Wrapper | Description |
| KeyValue* | scanModeConfig | The configuration given to the scheduled scan. |
| ConnectorSchedulingTrigger | - |
| Name | Type | Default value | Description |
| startTimestamp | long | - | |
| endTimestamp | long | - |
| Name | Type | Default value | Description |
| startTimestamp | long | - | |
| endTimestamp | long | - | |
| repeatInterval | long | - |
| Name | Type | Default value | Description |
| startTimestamp | long | - | |
| endTimestamp | long | - | |
| cronExpression | string | - | The Quartz Cron expression made of five time and date fields. |
| Name | Type | Default value | Description |
| builderClassId | string | - | Java class id of the PipelineBuilder implementation. |
| Type | Wrapper | Description |
| KeyValue* | - | Configuration of the PipelineBuilder implementation. |
| Type | Wrapper | Description |
| PipelineBranch | ScanPipeline | A PAPI Source processor will be automatically added at the beginning of the branch on connector's scan. |
| PipelineBranch | FetchPipeline | A PAPI Source processor will be automatically added at the beginning of the branch on connector's fetch. |
| Name | Type | Default value | Description |
| input | string | - | Name of the BranchAction used as input (with the processors'input if it is a Process action) |
| output | string | - | Name of the BranchAction used as input (with the processors'input if it is a Process action) |
| autolink | boolean | False | Links automatically successive BranchActions on their first input and output when they have no explicit link. |
| name | string | - | Unique name for this pipeline branch |
| Type | Wrapper | Description |
| BranchAction* | - | Actions in the branch |
| PipelineLink* | - | Links between actions |
| Name | Type | Default value | Description |
| source | string | - | Name of the output which is used as this link source |
| target | string | - | Name of the input which is used as this link target |
| Name | Type | Default value | Description |
| input | string | - | Name of the BranchAction used as input (with the processors'input if it is a Process action) |
| output | string | - | Name of the BranchAction used as input (with the processors'input if it is a Process action) |
| autolink | boolean | False | Links automatically successive BranchActions on their first input and output when they have no explicit link. |
| name | string | - | Unique name for this pipeline branch |
| nbThreads | int | 4 | Number of replications of this branch |
| Type | Wrapper | Description |
| BranchAction* | - | Actions in the branch |
| PipelineLink* | - | Links between actions |
| Name | Type | Default value | Description |
| name | string | - | Unique name for this pipeline branch |
| classId | string | - | Processor's class |
| Type | Wrapper | Description |
| KeyValue* | - | Processor's configuration |
| Name | Type | Default value | Description |
| name | string | - | Unique name for this pipeline branch |
| capacity | int | 0 | Maximum number elements in the queue. 0 means no limit |
| Name | Type | Default value | Description |
| name | string | - | Unique name for this pipeline branch |
| Name | Type | Default value | Description |
| name | string | - | Unique name for this pipeline branch |
| Name | Type | Default value | Description |
| name | string | - | Unique name for this pipeline branch |
| orderingByMarker | boolean | True | This behavior enables the restoration of sessions when a stream has been split into multiple streams which are joined by this processor. Even if some split streams process faster, the elements from the previous session will all be sent before beginning to send the next one. |
| Name | Type | Default value | Description |
| name | string | - | Unique name for this pipeline branch |
| Name | Type | Default value | Description |
| name | string | - | Unique name for this pipeline branch |
| field | string | - | Field name |
| value | string | - | Value to set the field to |
| Name | Type | Default value | Description |
| name | string | - | Unique name for this pipeline branch |
| origName | string | - | Original name of field. |
| newName | string | - | New name of field. |
| Name | Type | Default value | Description |
| name | string | - | Unique name for this pipeline branch |
| fields | string | - | Comma-separated list of fields to remove. |
| Name | Type | Default value | Description |
| name | string | - | Unique name for this pipeline branch |
| classId | string | - |
| Type | Wrapper | Description |
| KeyValue* | - |
| Name | Type | Default value | Description |
| buffer | boolean | True | Enables buffering of documents in the connector to send them as batches to the indexing server. |
| triggerIndexingAfterScan | boolean | False | Always triggers an indexing job after a completed scan. |
| profilePushOperations | boolean | False | Enables profiling of push operations.
The profiling can be costly on small documents. |
| automaticRestartOnFailure | boolean | True | When a scan throws a PushAPIException does this connector automatically restart?This allows the connector to retry a scan operation when a component in the indexing chain crashes. Set this option to false to disable the retry behavior. |
| Name | Type | Default value | Description |
| storeInDocumentCache | boolean | True | |
| minSizeForCachingB | long | - | |
| maxSizeForCachingB | long | - |
| Name | Type | Default value | Description |
| allowRawDocumentFetch | boolean | True | |
| customFetcherClass | string | - | |
| customFetcherUrl | string | - | Base URL used for retrieving documents from this connector. This is used for preview, thumbnails and raw fetch from the search results. For unmanaged connectors, this is always used. For managed connectors, if this parameter is given, it completely replaces the retriever within the connectors server. |
| fetchProtocol | string | - | Protocol implemented by the customFetcherURL.One of v1, v2, rpv3, or networkRetriever |
| Name | Type | Default value | Description |
| allowHTMLPreview | boolean | True | |
| allowImagePreview | boolean | True |
| Name | Type | Default value | Description |
| allowThumbnails | boolean | True | |
| precomputeThumbnails | boolean | False | |
| precomputedThumbnailsHeight | int | 120 | |
| precomputedThumbnailsWidth | int | 120 | |
| homePageOnly | boolean | False | When crawling web sites, only compute and generate thumbnails for the home pages |
| Name | Type | Default value | Description |
| version | long | - | - |
| verbose | boolean | False |
| Type | Wrapper | Description |
| ICrawler* | - |
| Name | Type | Default value | Description |
| name | string | - | The crawler name. It must be unique across all crawlers. |
| documentsType | string | - | The type of documents pushed by this connector. The type of documents must match one of the types declared in your CloudView license file. |
| fetcher | string | - | Which fetcher to use. |
| crawlerServer | string | - | Crawler server hosting this crawler. See Deployment configuration. |
| connectorServer | string | - | Connector server hosting the indexing part of this crawler. See Deployment configuration. |
| buildGroup | string | - | Target build group. |
| dataModel | string | - | The default data model for documents indexed by this crawler. |
| storeTextOnly | boolean | True | Whether to store original binary documents, or only converted text. |
| nthreads | int | 1 | The number of crawl threads which must be strictly positive. |
| aggressive | boolean | False | Whether to enable aggressive crawl, that never sleeps between two requests to the same host. |
| throttleTimeMS | int | 2500 | In the case of non-aggressive crawl, this defines the sleep interval between requests to the same host. |
| ignoreRobotsTxt | boolean | False | Whether to ignore robots.txt rules. Not recommended. |
| enableConvertProcessor | boolean | True | Whether to enable remoteconvert-based processor for links extracting in binary documents. |
| nearDuplicateDetector | boolean | True | Whether to enable the near-duplicate content detector. |
| patternsDetector | boolean | True | Whether to enable patterns detection in pages. |
| crawlSitemaps | boolean | True | Whether to crawl sitemaps. |
| disableConditionalGet | boolean | False | Whether to always fetch documents, even if the server tells it has not changed. |
| defaultAccept | boolean | False | Whether to crawl a url by default when it matches no other accept rule. |
| defaultIndex | boolean | False | Whether to index by default when a url matches no index rule. |
| defaultFollow | boolean | False | Whether to follow by default when a url matches no follow rule. |
| defaultFollowRoots | boolean | True | Whether to automatically follow root urls |
| enableSimpleSiteCollapsing | boolean | True | Whether to generate a site ID suitable for document collapsing. |
| simpleSiteCollapsingDepth | int | 0 | How many path segments to use to generate the site collapsing ID. |
| mimeTypesMode | string | exclude | Mime types white/black list |
| smartRefresh | boolean | True | Whether to crawl a fraction of refreshed urls. |
| smartRefreshMinAgeS | int | 3600 | Age in seconds at which we may refresh old urls. |
| smartRefreshMaxAgeS | int | 604800 | Age in seconds at which we force the refresh of old urls. |
| archiveDocuments | boolean | False | When enabled, deleted documents are not deleted, but kept with their deletion date. |
| enableConsolidation | boolean | True | Define if we use a standard PAPI or a consolidation PAPI. |
| Type | Wrapper | Description |
| StringConstantValue* | mimeTypes | |
| StringConstantValue* | sessionIdBlacklist | SessionId blacklist. These parameters are removed from URLs with a path or query part containing them. |
| KeyValue* | PushAPIFilter | |
| Root* | roots | A list of root urls to start the crawl from. |
| RootSet* | rootsets | A list of files to load urls/sites from. |
| CrawlSchedulerConfig | - | |
| CustomCrawlConfig | - | |
| Rules* | - | |
| UrlTesterData | - |
| Name | Type | Default value | Description |
| priority0 | int | 100000 | Fifo priorities. by default, only user-submitted urls |
| priority1 | int | 10000 | by default, only redirected urls |
| priority2 | int | 1000 | by default, only indexed and not followed urls |
| priority3 | int | 100 | by default, only indexed and followed urls |
| priority4 | int | 10 | by default, only followed and not indexed urls |
| refreshPriority | int | 1 | refresh source |
| Name | Type | Default value | Description |
| preProcessorClassId | string | - | Custom PreProcessor. Called at the end of the preprocess pipe. |
| fetcherClassId | string | - | Custom Fetcher. |
| processorClassId | string | - | Custom Processor. Called at the end of the process pipe. Catches all mime types. |
| htmlProcessorClassId | string | - | Custom HTML Processor. Called at the of the html process pipe. Catches only html documents. |
| linksFilterClassId | string | - | Custom LinksFilter. Called at the end of the links filter list. Can decide whether to crawl an outgoing link. |
| postProcessorClassId | string | - | Custom PostProcessor. Called at the end of the postprocess pipe. |
| crawlerTemplate | string | - | Alternatively, specify the url of a xml file describing the whole crawler. |
| Name | Type | Default value | Description |
| key | string | - | How to interpret these rules. auto, adminui: place index/follow/accept rules where relevant, automatically. may break complex rules depending on other key-values pre, post, link, papi: place in preprocessor, postprocessor, linksfilter or papi filter only. |
| group | string | default | Key used to group rules and root urls. |
| Type | Wrapper | Description |
| Rule* | - |
| Type | Wrapper | Description |
| Action* | - | |
| Pattern* | - | |
| PostFilter* | - |
| Name | Type | Default value | Description |
| token | string | - | |
| caseSensitive | boolean | True |
| Name | Type | Default value | Description |
| token | string | - | |
| caseSensitive | boolean | True | |
| strict | boolean | False |
| Name | Type | Default value | Description |
| token | string | - | |
| caseSensitive | boolean | True |
| Name | Type | Default value | Description |
| token | string | - | |
| caseSensitive | boolean | True |
| Name | Type | Default value | Description |
| token | string | - | |
| field | string | - | |
| keyNamePrefix | string | crawlUrl.capture |
| Name | Type | Default value | Description |
| field | string | - | the field on which the pattern is applied A field may be the whole url or a part of it (url, scheme, host, port, path, query) |
| kind | string | - | specify the semantics of the attribute value - "length": specify the length of a field ([:10], [11:12], [30:]) - "exact", "prefix", "suffix", "inside": specify a regexp and its anchoring @warning for readability purpose, regexp escaping policy is reversed. Special characters must be backslash escaped: write "www.\.\*.tv" instead of "www\..*\.tv" (backslash must be itself escaped in C-style strings, a single backslash is really needed, in xml for example) |
| norm | string | none | Specify the normalization level (default is case insentive match) values: norm, lower or none |
| value | string | - | value (regexp) |
| matchedUrl | string | - | If not empty, this rule applies on the url provided with the name matchedUrl, instead of the main url. |
| litteral | boolean | True |
| Name | Type | Default value | Description |
| crossLevel | string | - | |
| numerical | boolean | True |
| Name | Type | Default value | Description |
| searchDateInPath | boolean | True | |
| searchDateInQuery | boolean | True | |
| maxYearsBefore | int | -1 | |
| maxYearsAfter | int | -1 | |
| maxMonthsBefore | int | -1 | |
| maxMonthsAfter | int | -1 | |
| maxDaysBefore | int | -1 | |
| maxDaysAfter | int | -1 | |
| searchDateFormats | string | - | |
| matchIfOutsideRange | boolean | False | |
| matchIfNoDate | boolean | False |
| Name | Type | Default value | Description |
| classId | string | - | The specified class must implement the {@code com.exalead.actionrules.CustomPostFilter} Exascript interface. |
| Type | Wrapper | Description |
| KeyValue* | - |
| Type | Wrapper | Description |
| UrlTestConfig* | urls |
| Name | Type | Default value | Description |
| url | string | - | |
| group | string | default | |
| enableAdvancedMode | boolean | False | |
| accept | boolean | False | |
| index | boolean | False | |
| follow | boolean | False |
| Name | Type | Default value | Description |
| url | string | - | The root url. |
| site | boolean | True | Enable site-mode: only crawl urls that belong to this 'site'. |
| priority | int | 0 | Priority shift. Increase or decrease priority. 0 means normal, -1 is higher priority, +1 lower. |
| group | string | default | Key used to group rules and root urls. |
| kvs | string | - | A semi-colon separated list of key-values. example: "key1=value1;key2=value2" |
| Name | Type | Default value | Description |
| url | string | - | |
| group | string | default | Key used to group rules and root urls. |
| Name | Type | Default value | Description |
| name | string | - | The crawler name. It must be unique across all crawlers. |
| documentsType | string | - | The type of documents pushed by this connector. The type of documents must match one of the types declared in your CloudView license file. |
| fetcher | string | - | Which fetcher to use. |
| crawlerServer | string | - | Crawler server hosting this crawler. See Deployment configuration. |
| connectorServer | string | - | Connector server hosting the indexing part of this crawler. See Deployment configuration. |
| buildGroup | string | - | Target build group. |
| dataModel | string | - | The default data model for documents indexed by this crawler. |
| storeTextOnly | boolean | True | Whether to store original binary documents, or only converted text. |
| nthreads | int | 1 | The number of crawl threads which must be strictly positive. |
| aggressive | boolean | False | Whether to enable aggressive crawl, that never sleeps between two requests to the same host. |
| throttleTimeMS | int | 2500 | In the case of non-aggressive crawl, this defines the sleep interval between requests to the same host. |
| ignoreRobotsTxt | boolean | False | Whether to ignore robots.txt rules. Not recommended. |
| enableConvertProcessor | boolean | True | Whether to enable remoteconvert-based processor for links extracting in binary documents. |
| nearDuplicateDetector | boolean | True | Whether to enable the near-duplicate content detector. |
| patternsDetector | boolean | True | Whether to enable patterns detection in pages. |
| crawlSitemaps | boolean | True | Whether to crawl sitemaps. |
| disableConditionalGet | boolean | False | Whether to always fetch documents, even if the server tells it has not changed. |
| defaultAccept | boolean | False | Whether to crawl a url by default when it matches no other accept rule. |
| defaultIndex | boolean | False | Whether to index by default when a url matches no index rule. |
| defaultFollow | boolean | False | Whether to follow by default when a url matches no follow rule. |
| defaultFollowRoots | boolean | True | Whether to automatically follow root urls |
| enableSimpleSiteCollapsing | boolean | True | Whether to generate a site ID suitable for document collapsing. |
| simpleSiteCollapsingDepth | int | 0 | How many path segments to use to generate the site collapsing ID. |
| mimeTypesMode | string | exclude | Mime types white/black list |
| smartRefresh | boolean | True | Whether to crawl a fraction of refreshed urls. |
| smartRefreshMinAgeS | int | 3600 | Age in seconds at which we may refresh old urls. |
| smartRefreshMaxAgeS | int | 604800 | Age in seconds at which we force the refresh of old urls. |
| archiveDocuments | boolean | False | When enabled, deleted documents are not deleted, but kept with their deletion date. |
| enableConsolidation | boolean | True | Define if we use a standard PAPI or a consolidation PAPI. |
| refreshDelayS | int | 60 | minimum delay before refreshing any url, default is 1 minute |
| Type | Wrapper | Description |
| StringConstantValue* | mimeTypes | |
| StringConstantValue* | sessionIdBlacklist | SessionId blacklist. These parameters are removed from URLs with a path or query part containing them. |
| KeyValue* | PushAPIFilter | |
| Feed* | feeds | a list of feeds |
| RootSet* | rootsets | A list of files to load urls/sites from. |
| CrawlSchedulerConfig | - | |
| CustomCrawlConfig | - | |
| Rules* | - | |
| UrlTesterData | - |
| Name | Type | Default value | Description |
| url | string | - | The root url. |
| site | boolean | True | Enable site-mode: only crawl urls that belong to this 'site'. |
| priority | int | 0 | Priority shift. Increase or decrease priority. 0 means normal, -1 is higher priority, +1 lower. |
| group | string | default | Key used to group rules and root urls. |
| kvs | string | - | A semi-colon separated list of key-values. example: "key1=value1;key2=value2" |
| refreshPeriodS | int | 600 | how often to refresh this feed, default 10min |
| indexFeedItems | boolean | True | whether to index all items found in the feed with metas, before crawling them |
| indexItemDocuments | boolean | True | whether to crawl the items and index the full item pages |
| findFeeds | boolean | False | whether to crawl feeds found in html headers <link href="" rel="alternate" /> |
| forceFeedMimeType | boolean | True | force processing of url as xml feed (for servers returning buggy content types) can't work with findFeeds enabled. |
| findMediaLinks | boolean | True | find <img src="" /> and youtube/dailymotion links in item text and push them as metas |
| Type | Wrapper | Description |
| KeyValue* | - |
| Name | Type | Default value | Description |
| version | long | - | - |
| defaultFetcher | string | - | |
| dnsServer | string | - | |
| defaultMaxSizeKB | int | - | |
| defaultTruncate | boolean | False | |
| sessionLifetime | int | 600 | Cookie session lifetime in seconds |
| fullDocumentMaxSizeKB | int | 32768 | |
| crawlCacheProxyAddress | string | - | Crawl through multibox (WebExperiencePlatform mode). |
| crawlCacheProxyUsername | string | - | |
| crawlCacheProxyPassword | string | - | |
| crawlCacheRequestTimeoutMS | long | 10000 | |
| globalProxyHost | string | - | |
| globalProxyPort | int | - | |
| globalProxyUsername | string | - | |
| globalProxyPassword | string | - | |
| globalProxyDomain | string | - | |
| nonProxyHosts | string | - |
| Type | Wrapper | Description |
| MimeConfig* | mimes | |
| Fetcher* | - |
| Name | Type | Default value | Description |
| name | string | - | |
| type | string | - | |
| classId | string | - | |
| readTimeoutS | int | 15 | |
| writeTimeoutS | int | 15 | |
| connectTimeoutS | int | 30 | |
| maxDownloadTimeS | int | 600 | |
| userAgent | string | - | |
| from | string | - | |
| cookies | boolean | False | |
| proxyAddr | string | - | |
| proxyUsername | string | - | |
| proxyPassword | string | - | |
| proxyDomain | string | - | |
| useConnectForHttpsOverProxy | boolean | True | |
| useCrawlCache | boolean | False | Crawl through crawl cache proxy. (WebExperiencePlatform mode). |
| maxAgeS | long | 2592000 | Max allowed age of docs fetched in cache. Older docs are recrawled. Default is 1 month |
| Name | Type | Default value | Description |
| name | string | - | |
| value | string | - |
| Name | Type | Default value | Description |
| name | string | - |
| Type | Wrapper | Description |
| Pattern* | - | |
| RulesConfig | - |
| Name | Type | Default value | Description |
| type | string | - | |
| username | string | - | |
| password | string | - | |
| realm | string | - | |
| domain | string | - | |
| host | string | - |
| Name | Type | Default value | Description |
| gatewayUrl | string | - | |
| formId | string | - | if there are more than one form on the gateway Url, a formName formId and/or a formClass can be specified to find the right one. |
| formClass | string | - | |
| formName | string | - | |
| method | string | - | when method or action are not null, they override the ones found in the form. when gatewayUrl is null, just use them. gatewayUrl, method and action must not all be null. |
| action | string | - | |
| autoSubmittedForms | int | 0 | How many times to try to find and submit a form after the login procedure. This is needed to get cookies for other domains in some SSOs. |
| additionalRequest | string | - | An additional URL to fetch after the HTML form authentication procedure,
following all redirections to allow new cookies. Useful for some SSO including google sites. |
| Type | Wrapper | Description |
| KeyValue* | - |
| Name | Type | Default value | Description |
| success | boolean | True |
| Type | Wrapper | Description |
| Cond* | - |
| Name | Type | Default value | Description |
| success | boolean | True |
| Type | Wrapper | Description |
| Cond* | - |
| Name | Type | Default value | Description |
| success | boolean | True |
| Type | Wrapper | Description |
| Cond | - |
| Name | Type | Default value | Description |
| mime | string | - | |
| maxSizeKB | int | - | |
| truncate | boolean | True | When setting truncate to false, the file won't be crawled if size exceeds maxSizeKB. This is useful for binary files, such as pdf, because truncated binary files can not be processed |
| Type | Wrapper | Description |
| ConvertDocumentInputSettings | - | |
| ConvertDocumentOutputSettings | - | |
| ConvertDocumentProcessingSettings | - | |
| ConvertInternalSettings | - | |
| ConvertJavaPluginsSettings | - |
| Name | Type | Default value | Description |
| minSizeKB | int | -1 | Default minimum size in kilobytes for a document to be converted. The default is -1 which means no limit. Note: This setting defines the process default value, which can be overridden for each conversion command. |
| maxSizeKB | int | -1 | Default maximumm size in kilobytes for a document to be converted. The default is -1 which means use program defaults (250MB). Note: This setting defines the process default value, which can be overridden for each conversion command. |
| maxSizeForTextDocumentsKB | int | -1 | Default maximum size in kilobytes for textual (html, xml, text)
documents to be converted. The default is -1 which means use program defaults (250MB). Note: This setting defines the process default value, which can be overridden for each conversion command. |
| Name | Type | Default value | Description |
| maxSizeKB | int | -1 | Default maximum size in bytes for converted documents. The default is -1 which means no limit. Note: This setting defines the process default value, which can be overridden for each conversion command. |
| maxConvertedPagesForXmlOutput | int | -1 | Default maximum number of document pages to be converted into xml. The default is -1 which means no limit. The definition of a page is tightly linked to document type: (pdf page, doc page, etc) Note: This setting defines the process default value, which can be overridden for each conversion command. |
| maxConvertedPagesForHtmlOutput | int | -1 | Default maximum number of document pages to be converted into html. The default is -1 which means no limit. The definition of a page is tightly linked to document type: (pdf page, doc page, etc) Note: This setting defines the process default value, which can be overridden for each conversion command. |
| Name | Type | Default value | Description |
| conversionTimeoutS | int | -1 | Default timeout in seconds for conversion. The default is -1 which means use program defaults (30 seconds). The conversion will be considered as failed if it takes longer than conversionTimeout. Note: This setting defines the process default value, which can be overridden for each conversion command. |
| conversionTimeoutPerMegabyteS | int | -1 | Default timeout in seconds per megabyte for conversion. The conversion fails if it takes more than conversionTimeout * (size of document in Megabytes). The default is -1 which means "undefined". Note: This setting defines the process default value, which can be overridden for each conversion command. |
| conversionGraceTimeoutS | int | -1 | Global conversion grace timeout value in seconds. The convert process will kill a non-responding minion thread after this timeout. The default is -1 which means use program defaults (30 seconds). |
| enableImageResizing | boolean | True | Enables commands related to images resizing (used in thumbnails computation). |
| netcamMode | string | optional | Enables Netcam feature: disabled: Disables the feature enabled: Enables the feature optional: Enables the feature if available {@code enum("disabled", "enabled", "optional")} |
| netcamTimeoutS | int | -1 | Default Netcam conversion timeout in seconds. The default is -1 which means use program defaults (30 seconds). Note: This setting defines the process default value, which can be overridden for each conversion command. |
| netcamAsyncTimeoutS | int | -1 | Netcam asynchronous command timeout in seconds. It should be set to a low value, as it is applied to async commands. The default is -1 which means use program defaults (10 seconds). |
| netcamJobsPerMinion | int | -1 | The number of Netcam jobs per minion thread. The default is -1 which means use program defaults (4). |
| netcamMaxJobsPerMinion | int | -1 | Total number of jobs a minion can process before being recycled. The default is -1 which means use program defaults (128). |
| netcamJobsRetries | int | -1 | Number of Netcam jobs retries if a remote exception occurs. The default is -1 which means use program defaults (4). |
| netcamProxy | string | - | Optional proxy, or null if undefined. |
| ttfDir | string | - | The font path (necessary on UNIX). Used for thumbnail generation. |
| indexSingleContainersAsOneDocument | boolean | False | Default indexing mode for containers (ZIP, TAR, PST, ...) to be converted as a single document, instead of indexing the directory only. By default, it indexes only the container directory. Note: This function has no impact on container commands (i.e., opening, listing, ...). Note: This setting defines the process default value, which can be overridden for each conversion command. |
| singleContainersMaxRecursionDepth | int | 1 | Default maximum recursion depth (for containers, or containers inside
containers). Only taken in account if indexSingleContainersAsOneDocument = true Note: This setting defines the process default value, which can be overridden for each conversion command. |
| singleContainersMaxRecursionDocuments | int | 2147483647 | Default maximum number of documents that can be indexed in a container. Only taken in account if indexSingleContainersAsOneDocument = true Note: This setting defines the process default value, which can be overridden for each conversion command. |
| singleContainersMaxRecursionDocumentsTotal | int | 2147483647 | Default maximum number of documents that can be indexed in a container
and all its children (for containers inside containers). Only taken in account if indexSingleContainersAsOneDocument = true Note: This setting defines the process default value, which can be overridden for each conversion command. |
| allowUnicode32 | boolean | True | Allows the use of 32-bit unicode points when processing documents. This will allow to produce Unicode characters greater than 65536. |
| allowDocumentChars | boolean | True | Allows the use of Unicode private range characters (E0XX) for separators (keyword, sentence, paragraph separators, ...) |
| metaSeparator | string | : | Character separator for meta-data namespaces. Note: MUST be a printable ascii character (Unicode codepoint must be higher than 32 and strictly lower than 128) |
| iFilterExtensions | string | - | Comma-separated list of extensions to be processed through the Windows IFilter interface. Only available on Windows. |
| excelDateFormat | int | 0 | Date default format to be used to interpret date cells in excel: 0:MM/DD/YYYY, 1:YYYY/MM/DD, 2:DD/MM/YYYY |
| Name | Type | Default value | Description |
| retryOnMMAPFailed | boolean | False | Default convert retry with regular I/O if mmap fails when the convert is
responsible for fetching the bytes of a document. This is useful for FileSystem mounted in direct I/O. Note: This setting defines the process default value, which can be overridden for each conversion command. |
| disableSharedMemory | boolean | False | Disables shared memory support. |
| loggingLevel | string | - | Sets logging verbosity of the convert. verbose: Logs converted urls quiet: Logs errors only. {@code enum ("verbose", "quiet")} |
| tmpDir | string | - | The temporary path to override the system temporary path. |
| selftestOnStartup | boolean | False | The converter tests itself on startup. |
| restrictUserId | boolean | False | Restricts connections to the user running the server. Supported only on Windows and Linux platforms. |
| Type | Wrapper | Description |
| ConvertInternalCacheSettings | - | |
| ConvertInternalChildrenSettings | - | |
| ConvertInternalPOSIXSettings | - | |
| KeyValue* | - | |
| StringValue* | - |
| Name | Type | Default value | Description |
| minAgeS | long | -1 | Minimum age (in seconds) for an item in the cache. This is useful for big files that we don't want to frequently update in the cache, for performance reasons. The default is -1 which means no limit. |
| maxAgeS | long | -1 | Maximum age (in seconds) for an item in the cache. The default is -1 which means no limit. |
| maxSizeMB | int | -1 | Maximum size (in megabytes) for the cache. The default is -1 which means no limit. |
| maxSizePerFileKB | int | -1 | Maximum size (in kilobytes) for an item to be cached. The default is -1 which means no limit. |
| Name | Type | Default value | Description |
| maxChildren | int | -1 | Maximum authorized number of children. The default is -1 which means use program defaults (128). |
| maxIdleChildren | int | -1 | Children that were created can be reused for future conversion. This parameter specifies the max number of idle children for future use. After long inactivity, all children will die and be re-forked if necessary. The default is -1 which means use program defaults (32). |
| maxIdleChildrenPerGroup | int | -1 | Children that were created for a specific group can be reused for future conversion. This parameter specifies the max number of idle children for each group for future use. After long inactivity, all children will die and be re-forked if necessary. The default is -1 which means use program defaults (automatic). |
| childSpawnTimeoutS | int | -1 | Children spawn timeout in seconds. The default is -1 which means use program defaults (20 seconds). |
| ChildConvertInitTimeoutS | int | -1 | Minion convert libraries and plugins initialization timeout in seconds. The default is -1 which means use program defaults (30 seconds). |
| exec32Mode | string | disabled | Select 32-bit support disabled: Disables the feature enabled: Enables the feature optional: Enables the feature if available {@code enum("disabled", "enabled", "optional")} |
| Name | Type | Default value | Description |
| maxProcessMemorySizeMB | int | -1 | Maximum allowed memory for a convert process (main or child) (posix: maxas). The default is -1 which means no limit. |
| maxCoreFileSizeMB | int | -1 | Maximum allowed size for core files (posix: maxcore). The default is -1 which means no limit. |
| maxCreatedFileSizeKB | int | -1 | Maximum allowed size for created files such as temporary files etc (posix: maxfsize). The default is -1 which means no limit. |
| maxNumberOfOpenedFiles | int | -1 | Maximum allowed number of opened files (posix: maxnofile). The default is -1 which means no limit. |
| maxResidentMemorySizeMB | int | -1 | Maximum allowed size in bytes for resident memory (posix: maxrss). The default is -1 which means no limit. |
| Type | Wrapper | Description |
| ConvertJavaPluginSetting* | - |
| Name | Type | Default value | Description |
| classId | string | - | Java class name. |
| disabled | boolean | False | Is the plugin disabled? |
| Type | Wrapper | Description |
| KeyValue* | - |
| Name | Type | Default value | Description |
| name | string | - | Name of the analysis module. Must be unique. |
| linguistic | boolean | True | Extracts linguistic data for the dictionary, such as word counts. This impacts the ability to compute related terms and use word counts for ranking. |
| Type | Wrapper | Description |
| AnalysisPipeline* | - |
| Name | Type | Default value | Description |
| name | string | - | |
| errorAction | string | continue | Specifies the action to launch if there is a document error during processing:
|
| reportDocumentErrors | boolean | True | Reports the document errors in the global reporting store, for further analysis. |
| globalLogDocumentErrors | boolean | False | Logs errors and exceptions reported by the processors in the global log (without stack trace). |
| autoBlacklistDocuments | boolean | True | Tries to add to a block list the documents triggering serious failure automatically. This option helps preventing loop failures, that is to say, when documents always trigger the same analysis process failures. |
| tokenizationConfig | string | - | Reference to the TokenizationConfig object to use for tokenization during Semantic Processing Stage. |
| autoconfigureFromDataModel | boolean | True | |
| documentProcessorsProfiling | boolean | False | Logs the CPU time spent for each document processor and for the main indexing phase. The total time spent for each processor is dumped in the analyzer log at the end of the job. |
| semanticPipeTimeout | int | 0 | CPU-time limit for the processing of a text chunk by the semantic pipe, in seconds. |
| slowDocumentWarningTimeUS | long | 5000000 | If the processing of a document is longer than this time, a message will be printed in the analyzer log. A value of 0 disables the warning feature. |
| semanticProcessorsProfiling | boolean | False | Logs the CPU time spent for each semantic processor. The total time spent for each processor is dumped in the analyzer log at the end of the job. Warning: This feature strongly impacts performance, only enable it if required. |
| Type | Wrapper | Description |
| AcceptCondition | - | |
| DocumentProcessor* | - | |
| FilteringConfiguration | - | |
| LanguageConfiguration* | - | |
| MappingConfiguration | - | |
| SemanticProcessor* | - |
| Type | Wrapper | Description |
| AcceptCondition* | - |
| Type | Wrapper | Description |
| AcceptCondition* | - |
| Type | Wrapper | Description |
| AcceptCondition | - |
| Name | Type | Default value | Description |
| source | string | - | Value of the 'source' for the document against which to check. |
| Name | Type | Default value | Description |
| name | string | - | Value of the "buildgroup" for the document against which to check. |
| Name | Type | Default value | Description |
| name | string | - | Name of the meta against which to check. |
| nameMode | enum(equals, matches) | equals | Meta name test mode:
|
| valueMode | enum(equals, contains, exists, matches) | exists | Value test mode:
|
| value | string | - | The string to check against the value of DocumentChunks. |
| Type | Wrapper | Description |
| StringValue* | mimes |
| Name | Type | Default value | Description |
| regexp | string | - | The regexp. Note: It is not anchored by default ; i.e., use '.*\.asp to match .asp URIs. |
| Name | Type | Default value | Description |
| regexp | string | - | The regexp. Note: It is not anchored by default ; i.e., use '.*\.doc' to match .doc files. |
| Name | Type | Default value | Description |
| offset | int | - | Offset in bytes for the binary data to be compared, in bytes (0 for the beginning of the file). Negative values are taken as offset from the end of the file (-1 for the last byte). |
| match | string | - | Binary string to be compared. The string may contain any ASCII (7-bit) character, or the following '\' escape sequences:
|
| Name | Type | Default value | Description |
| className | string | - | The restricted DataModel class |
| Name | Type | Default value | Description |
| directiveName | string | - | The expected directive name |
| directiveValue | string | - | An optional expected value for the given directive |
| Name | Type | Default value | Description |
| name | string | - | Name of this processor. The name of a processor is used only for tracing and debugging purposes. |
| dataModelState | string | - | Is this document processor managed by a data model? @enum{null,auto,customized, error}.
|
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disable the DocumentProcessor |
| languageContext | string | - | If this is not null and if there is a DocumentChunk with a ContextName matching 'languageContext':
|
| languagesToDetect | string | - | If not null, restrict the language detector to a set of languages. If you only have a small set of languages to detect, you can restrict language detector to this set to improve precision. List is comma-separated, ex: "en,fr" |
| defaultLanguage | string | - | If not null, 'defaultLanguage' will be used as the default language when automatic detection fails. |
| exclude | boolean | False | If true, "inputContexts" is an exclude list instead of an include list. Language detection is then performed on all DocumentChunks except those whose ContextName appears in 'inputContexts'. |
| outputContext | string | - | ContextName of the DocumentChunk to create. It will contain the language detected in the processed DocumentChunks as defined in ISO 639-1. |
| minLangPercentage | int | 33 | Minimum ratio ([0-100]) of language to be detected (0 = always keeps a detected language) |
| languagesToKeep | int | 0 | Keeps the n most represented languages in the document. A value of 0 lets the minLangPercentage select the languages. |
| Type | Wrapper | Description |
| StringValue* | inputContexts | The processor will only be applied to DocumentChunks with a ContextName specified in this list. |
| DocumentProcessor | fromDataModel | If dataModelState is "customized", you will find here the
original document processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| AcceptCondition | - | Expresses the enablement condition of this DocumentProcessor. |
| Name | Type | Default value | Description |
| name | string | - | Name of this processor. The name of a processor is used only for tracing and debugging purposes. |
| dataModelState | string | - | Is this document processor managed by a data model? @enum{null,auto,customized, error}.
|
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disable the DocumentProcessor |
| language | iso code | - | Language specified by ISO 639-1 code. |
| outputContext | string | - | ContextName of the DocumentChunk to create. It will contain the language name as defined in ISO 639-1. |
| Type | Wrapper | Description |
| StringValue* | inputContexts | The processor will only be applied to DocumentChunks with a ContextName specified in this list. |
| DocumentProcessor | fromDataModel | If dataModelState is "customized", you will find here the
original document processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| AcceptCondition | - | Expresses the enablement condition of this DocumentProcessor. |
| Name | Type | Default value | Description |
| name | string | - | Name of this processor. The name of a processor is used only for tracing and debugging purposes. |
| dataModelState | string | - | Is this document processor managed by a data model? @enum{null,auto,customized, error}.
|
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disable the DocumentProcessor |
| duplicateWhitespaces | boolean | False | Removes duplicate whitespaces. (' ' -> ' ') |
| leading | boolean | False | Removes the leading whitespaces |
| trailing | boolean | False | Removes the trailing whitespaces |
| spaces | boolean | False | Removes *all* whitespaces. |
| stripHTML | boolean | False | Strips HTML tags |
| Type | Wrapper | Description |
| StringValue* | inputContexts | The processor will only be applied to DocumentChunks with a ContextName specified in this list. |
| DocumentProcessor | fromDataModel | If dataModelState is "customized", you will find here the
original document processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| AcceptCondition | - | Expresses the enablement condition of this DocumentProcessor. |
| Name | Type | Default value | Description |
| name | string | - | Name of this processor. The name of a processor is used only for tracing and debugging purposes. |
| dataModelState | string | - | Is this document processor managed by a data model? @enum{null,auto,customized, error}.
|
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disable the DocumentProcessor |
| outputContext | string | - | ContextName to be associated with the DocumentChunk created for each selection. |
| Type | Wrapper | Description |
| StringValue* | inputContexts | The processor will only be applied to DocumentChunks with a ContextName specified in this list. |
| DocumentProcessor | fromDataModel | If dataModelState is "customized", you will find here the
original document processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| AcceptCondition | - | Expresses the enablement condition of this DocumentProcessor. |
| Name | Type | Default value | Description |
| name | string | - | Name of this processor. The name of a processor is used only for tracing and debugging purposes. |
| dataModelState | string | - | Is this document processor managed by a data model? @enum{null,auto,customized, error}.
|
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disable the DocumentProcessor |
| deleteInvalidChunks | boolean | False | Removes invalid chunks from documents. |
| Type | Wrapper | Description |
| StringValue* | inputContexts | The processor will only be applied to DocumentChunks with a ContextName specified in this list. |
| DocumentProcessor | fromDataModel | If dataModelState is "customized", you will find here the
original document processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| AcceptCondition | - | Expresses the enablement condition of this DocumentProcessor. |
| Name | Type | Default value | Description |
| name | string | - | Name of this processor. The name of a processor is used only for tracing and debugging purposes. |
| dataModelState | string | - | Is this document processor managed by a data model? @enum{null,auto,customized, error}.
|
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disable the DocumentProcessor |
| outputContext | string | - | ContextName to be associated with the DocumentChunk created for each concatenated value. |
| join | string | - | Optional string inserted between concatenated values. |
| strict | boolean | True | Forces all the input contexts found to generate the concatenation. |
| allowDuplicates | boolean | True | If true, and if there are multiple DocumentChunks with the same ContextName, it concatenates them all. If false, only the first DocumentChunk among all those with the same ContextName is kept. |
| cartesianProduct | boolean | False | If there are multiple DocumentChunks with the same ContextName, it generates the cartesian product between all values. |
| Type | Wrapper | Description |
| StringValue* | inputContexts | The processor will only be applied to DocumentChunks with a ContextName specified in this list. |
| DocumentProcessor | fromDataModel | If dataModelState is "customized", you will find here the
original document processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| AcceptCondition | - | Expresses the enablement condition of this DocumentProcessor. |
| Name | Type | Default value | Description |
| name | string | - | Name of this processor. The name of a processor is used only for tracing and debugging purposes. |
| dataModelState | string | - | Is this document processor managed by a data model? @enum{null,auto,customized, error}.
|
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disable the DocumentProcessor |
| Type | Wrapper | Description |
| StringValue* | inputContexts | The processor will only be applied to DocumentChunks with a ContextName specified in this list. |
| DocumentProcessor | fromDataModel | If dataModelState is "customized", you will find here the
original document processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| AcceptCondition | - | Expresses the enablement condition of this DocumentProcessor. |
| Name | Type | Default value | Description |
| name | string | - | Name of this processor. The name of a processor is used only for tracing and debugging purposes. |
| dataModelState | string | - | Is this document processor managed by a data model? @enum{null,auto,customized, error}.
|
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disable the DocumentProcessor |
| outputContext | string | - | The ContextName used for newly created chunks. |
| processUnmappedContexts | boolean | False | All DocumentChunks with an unmapped ContextName in the document will be used for input. This can be used to emulate the 'default meta' and 'content' field feature of CloudView 4.6. |
| Type | Wrapper | Description |
| StringValue* | inputContexts | The processor will only be applied to DocumentChunks with a ContextName specified in this list. |
| DocumentProcessor | fromDataModel | If dataModelState is "customized", you will find here the
original document processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| AcceptCondition | - | Expresses the enablement condition of this DocumentProcessor. |
| Name | Type | Default value | Description |
| name | string | - | Name of this processor. The name of a processor is used only for tracing and debugging purposes. |
| dataModelState | string | - | Is this document processor managed by a data model? @enum{null,auto,customized, error}.
|
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disable the DocumentProcessor |
| nbBits | int | 64 | The size of the hash, in bits, including the sign bit. The hash values will be in [-2^(nbBits-1); 2^(nbBits-1) - 1]. |
| outputContext | string | - | The ContextName used for the newly created chunk. |
| Type | Wrapper | Description |
| StringValue* | inputContexts | The processor will only be applied to DocumentChunks with a ContextName specified in this list. |
| DocumentProcessor | fromDataModel | If dataModelState is "customized", you will find here the
original document processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| AcceptCondition | - | Expresses the enablement condition of this DocumentProcessor. |
| Name | Type | Default value | Description |
| name | string | - | Name of this processor. The name of a processor is used only for tracing and debugging purposes. |
| dataModelState | string | - | Is this document processor managed by a data model? @enum{null,auto,customized, error}.
|
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disable the DocumentProcessor |
| outputContext | string | - | The ContextName used for the newly created chunk. |
| Type | Wrapper | Description |
| StringValue* | inputContexts | The processor will only be applied to DocumentChunks with a ContextName specified in this list. |
| DocumentProcessor | fromDataModel | If dataModelState is "customized", you will find here the
original document processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| AcceptCondition | - | Expresses the enablement condition of this DocumentProcessor. |
| Name | Type | Default value | Description |
| name | string | - | Name of this processor. The name of a processor is used only for tracing and debugging purposes. |
| dataModelState | string | - | Is this document processor managed by a data model? @enum{null,auto,customized, error}.
|
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disable the DocumentProcessor |
| outputContext | string | - | The ContextName used for the newly created chunk. |
| Type | Wrapper | Description |
| StringValue* | inputContexts | The processor will only be applied to DocumentChunks with a ContextName specified in this list. |
| DocumentProcessor | fromDataModel | If dataModelState is "customized", you will find here the
original document processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| AcceptCondition | - | Expresses the enablement condition of this DocumentProcessor. |
| Name | Type | Default value | Description |
| name | string | - | Name of this processor. The name of a processor is used only for tracing and debugging purposes. |
| dataModelState | string | - | Is this document processor managed by a data model? @enum{null,auto,customized, error}.
|
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disable the DocumentProcessor |
| outputContext | string | - | The ContextName used for the newly created chunk. If null, it uses the same name as the input. |
| precision | int | 0 | Number of digits relevant in the decimal part. |
| round | int | 0 | Rounds the integer part with this range. |
| removeTrailingZeros | boolean | True | Removes the trailing zeros in the decimal part. |
| groupSeparator | string | - | group separator |
| decimalSeparator | string | . | decimal separator |
| Type | Wrapper | Description |
| StringValue* | inputContexts | The processor will only be applied to DocumentChunks with a ContextName specified in this list. |
| DocumentProcessor | fromDataModel | If dataModelState is "customized", you will find here the
original document processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| AcceptCondition | - | Expresses the enablement condition of this DocumentProcessor. |
| Name | Type | Default value | Description |
| name | string | - | Name of this processor. The name of a processor is used only for tracing and debugging purposes. |
| dataModelState | string | - | Is this document processor managed by a data model? @enum{null,auto,customized, error}.
|
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disable the DocumentProcessor |
| outputContext | string | - | The ContextName used for the newly created chunk. |
| latitudeContext | string | - | The ContextName used as input for the latitude |
| latitudeFormat | enum(DMS, Decimal) | The input format for the latitude Value can be one of
|
|
| longitudeContext | string | - | The ContextName used as input for the longitude |
| longitudeFormat | enum(DMS, Decimal) | The input format for the longitude Value can be one of
|
| Type | Wrapper | Description |
| StringValue* | inputContexts | The processor will only be applied to DocumentChunks with a ContextName specified in this list. |
| DocumentProcessor | fromDataModel | If dataModelState is "customized", you will find here the
original document processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| AcceptCondition | - | Expresses the enablement condition of this DocumentProcessor. |
| Name | Type | Default value | Description |
| name | string | - | Name of this processor. The name of a processor is used only for tracing and debugging purposes. |
| dataModelState | string | - | Is this document processor managed by a data model? @enum{null,auto,customized, error}.
|
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disable the DocumentProcessor |
| dump | boolean | True | |
| outputContext | string | - | The ContextName used for the newly created chunk. |
| Type | Wrapper | Description |
| StringValue* | inputContexts | The processor will only be applied to DocumentChunks with a ContextName specified in this list. |
| DocumentProcessor | fromDataModel | If dataModelState is "customized", you will find here the
original document processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| AcceptCondition | - | Expresses the enablement condition of this DocumentProcessor. |
| Name | Type | Default value | Description |
| name | string | - | Name of this processor. The name of a processor is used only for tracing and debugging purposes. |
| dataModelState | string | - | Is this document processor managed by a data model? @enum{null,auto,customized, error}.
|
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disable the DocumentProcessor |
| remoteMOTAPIConfigName | string | - |
| Type | Wrapper | Description |
| StringValue* | inputContexts | The processor will only be applied to DocumentChunks with a ContextName specified in this list. |
| DocumentProcessor | fromDataModel | If dataModelState is "customized", you will find here the
original document processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| StringValue* | targetInstances | |
| AcceptCondition | - | Expresses the enablement condition of this DocumentProcessor. |
| Name | Type | Default value | Description |
| name | string | - | Name of this processor. The name of a processor is used only for tracing and debugging purposes. |
| dataModelState | string | - | Is this document processor managed by a data model? @enum{null,auto,customized, error}.
|
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disable the DocumentProcessor |
| spaces | string | - | What to do with spaces ("trim" or "normalize-spaces", default set to nothing) |
| form | string | - | What transformation to apply ("lowercase", "uppercase", "normalized", "capitalized", default set to nothing) |
| Type | Wrapper | Description |
| StringValue* | inputContexts | The processor will only be applied to DocumentChunks with a ContextName specified in this list. |
| DocumentProcessor | fromDataModel | If dataModelState is "customized", you will find here the
original document processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| AcceptCondition | - | Expresses the enablement condition of this DocumentProcessor. |
| Name | Type | Default value | Description |
| inputContext | string | - | The processor will only be applied to DocumentChunks with this ContextName. |
| name | string | - | Name of this processor. The name of a processor is used only for tracing and debugging purposes. |
| dataModelState | string | - | Is this document processor managed by a data model? @enum{null,auto,customized, error}.
|
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disable the DocumentProcessor |
| Type | Wrapper | Description |
| DocumentProcessor | fromDataModel | If dataModelState is "customized", you will find here the
original document processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| AcceptCondition | - | Expresses the enablement condition of this DocumentProcessor. |
| KeyValue* | - |
| Name | Type | Default value | Description |
| inputContext | string | - | The processor will only be applied to DocumentChunks with this ContextName. |
| name | string | - | Name of this processor. The name of a processor is used only for tracing and debugging purposes. |
| dataModelState | string | - | Is this document processor managed by a data model? @enum{null,auto,customized, error}.
|
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disable the DocumentProcessor |
| treeOutputContext | string | - | The ContextName for the DocumentChunk created from the category path encoding the web site tree. |
| leafOutputContext | string | - | The ContextName for the DocumentChunks created from the complete, normalized, URL. |
| urlOutputContext | string | - | The ContextName for the DocumentChunk created from the complete, normalized URL. |
| urlPathOutputContext | string | - | The ContextName for the DocumentChunk created from the normalized URL. |
| maxPathDepth | int | 4 | maximum depth of url path |
| Type | Wrapper | Description |
| DocumentProcessor | fromDataModel | If dataModelState is "customized", you will find here the
original document processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| AcceptCondition | - | Expresses the enablement condition of this DocumentProcessor. |
| Name | Type | Default value | Description |
| inputContext | string | - | The processor will only be applied to DocumentChunks with this ContextName. |
| name | string | - | Name of this processor. The name of a processor is used only for tracing and debugging purposes. |
| dataModelState | string | - | Is this document processor managed by a data model? @enum{null,auto,customized, error}.
|
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disable the DocumentProcessor |
| dateTimeOutputContext | string | - | Suffix for the name of the DocumentChunk containing the date as defined by dateTimeOutputFormat (default YYYY/MM/DD-HH:MM:SS). The original ContextName of the input DocumentChunk and this suffix are concatenated ($orig$dateTimeOutputContext) to produce the ContextName actually used. This DocumentChunk is usually used for date display. |
| dateTimeOutputFormat | string | - | A date and time output format compliant with libc's strftime. |
| dateOutputContext | string | - | Suffix for the name of the DocumentChunk containing the date as defined by dateOutputFormat (default YYYY/MM/DD). The original name of the input DocumentChunk and this suffix are concatenated ($orig$dateTimeOutputContext) to produce the name actually used. This DocumentChunk is usually remapped to a category for navigation. |
| dateOutputFormat | string | - | A date output format compliant with libc's strftime. |
| timeOutputContext | string | - | Suffix for the name of the DocumentChunk containing the date as defined by timeOutputFormat (default HH:MM:SS). The original name of the input DocumentChunk and this suffix are concatenated ($orig$dateTimeOutputContext) to produce the name actually used. |
| timeOutputFormat | string | - | A time output format compliant with libc's strftime. |
| inputFormat | string | - | An optional date input format, compliant with libc's strptime() format.If such a format is provided, the automatic date format heuristic is disabled, and the provided date format is used exclusively. Documentation of accepted formats: (days and month literals are only recognized in English)
|
| removeOriginalChunk | boolean | True | Removes the original input chunk. |
| Type | Wrapper | Description |
| DocumentProcessor | fromDataModel | If dataModelState is "customized", you will find here the
original document processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| AcceptCondition | - | Expresses the enablement condition of this DocumentProcessor. |
| Name | Type | Default value | Description |
| inputContext | string | - | The processor will only be applied to DocumentChunks with this ContextName. |
| name | string | - | Name of this processor. The name of a processor is used only for tracing and debugging purposes. |
| dataModelState | string | - | Is this document processor managed by a data model? @enum{null,auto,customized, error}.
|
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disable the DocumentProcessor |
| inputFormat | string | - | An optional date input format, compliant with libc's strptime() format.If such a format is provided, the automatic date format heuristic is disabled, and the provided date format is used exclusively. Documentation of accepted formats: (days and month literals are only recognized in English)
|
| Type | Wrapper | Description |
| DocumentProcessor | fromDataModel | If dataModelState is "customized", you will find here the
original document processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| AcceptCondition | - | Expresses the enablement condition of this DocumentProcessor. |
| Name | Type | Default value | Description |
| inputContext | string | - | The processor will only be applied to DocumentChunks with this ContextName. |
| name | string | - | Name of this processor. The name of a processor is used only for tracing and debugging purposes. |
| dataModelState | string | - | Is this document processor managed by a data model? @enum{null,auto,customized, error}.
|
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disable the DocumentProcessor |
| outputContext | string | - | ContextName to be associated with the DocumentChunk created for each split segment. |
| separator | string | - | Separator around which to split. ASTL library is used to perform regular expression matching. The regular expression language supported is Perl 5, WITHOUT support for:
|
| Type | Wrapper | Description |
| DocumentProcessor | fromDataModel | If dataModelState is "customized", you will find here the
original document processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| AcceptCondition | - | Expresses the enablement condition of this DocumentProcessor. |
| Name | Type | Default value | Description |
| inputContext | string | - | The processor will only be applied to DocumentChunks with this ContextName. |
| name | string | - | Name of this processor. The name of a processor is used only for tracing and debugging purposes. |
| dataModelState | string | - | Is this document processor managed by a data model? @enum{null,auto,customized, error}.
|
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disable the DocumentProcessor |
| outputContext | string | - | The new ContextName for DocumentChunks with ContextName matching 'inputContext'. |
| Type | Wrapper | Description |
| DocumentProcessor | fromDataModel | If dataModelState is "customized", you will find here the
original document processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| AcceptCondition | - | Expresses the enablement condition of this DocumentProcessor. |
| Name | Type | Default value | Description |
| inputContext | string | - | The processor will only be applied to DocumentChunks with this ContextName. |
| name | string | - | Name of this processor. The name of a processor is used only for tracing and debugging purposes. |
| dataModelState | string | - | Is this document processor managed by a data model? @enum{null,auto,customized, error}.
|
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disable the DocumentProcessor |
| outputContext | string | - | The ContextName used for newly created chunks. |
| requiredAnnotation | string | - | The name of the required annotation the chunk must have to be copied. If null, no special handling is done on annotations. |
| restrictValues | string | - | A regexp which values of the chunk must match to be copied to the output context. Values that don't match the regexp will not be copied. |
| Type | Wrapper | Description |
| DocumentProcessor | fromDataModel | If dataModelState is "customized", you will find here the
original document processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| AcceptCondition | - | Expresses the enablement condition of this DocumentProcessor. |
| Name | Type | Default value | Description |
| inputContext | string | - | The processor will only be applied to DocumentChunks with this ContextName. |
| name | string | - | Name of this processor. The name of a processor is used only for tracing and debugging purposes. |
| dataModelState | string | - | Is this document processor managed by a data model? @enum{null,auto,customized, error}.
|
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disable the DocumentProcessor |
| outputContext | string | - | The ContextName used for newly created chunks. |
| separator | string | _ | The range separator. |
| rangeSize | long | 1 | The size of the range to consider. |
| Type | Wrapper | Description |
| DocumentProcessor | fromDataModel | If dataModelState is "customized", you will find here the
original document processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| AcceptCondition | - | Expresses the enablement condition of this DocumentProcessor. |
| Name | Type | Default value | Description |
| inputContext | string | - | The processor will only be applied to DocumentChunks with this ContextName. |
| name | string | - | Name of this processor. The name of a processor is used only for tracing and debugging purposes. |
| dataModelState | string | - | Is this document processor managed by a data model? @enum{null,auto,customized, error}.
|
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disable the DocumentProcessor |
| outputContext | string | - | The ContextName used for newly created chunks. |
| separator | string | _ | The separator between the beginning and the end of the range. This parameter is deprecated. |
| Type | Wrapper | Description |
| DocumentProcessor | fromDataModel | If dataModelState is "customized", you will find here the
original document processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| AcceptCondition | - | Expresses the enablement condition of this DocumentProcessor. |
| NumericalRange* | - | The forced ranges. |
| Name | Type | Default value | Description |
| beg | long | - | The lower bound. |
| end | long | - | The upper bound. |
| text | string | - | The associated text. |
| Name | Type | Default value | Description |
| inputContext | string | - | The processor will only be applied to DocumentChunks with this ContextName. |
| name | string | - | Name of this processor. The name of a processor is used only for tracing and debugging purposes. |
| dataModelState | string | - | Is this document processor managed by a data model? @enum{null,auto,customized, error}.
|
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disable the DocumentProcessor |
| alphabet | string | 0123456789abcdefghijklmnopqrstuvwxyz | The ordered alphabet. |
| outputContext | string | - | The ContextName used for the newly created chunk. |
| nbBits | int | 63 | Number of bits of unsigned field used for sorting. |
| Type | Wrapper | Description |
| DocumentProcessor | fromDataModel | If dataModelState is "customized", you will find here the
original document processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| AcceptCondition | - | Expresses the enablement condition of this DocumentProcessor. |
| Name | Type | Default value | Description |
| inputContext | string | - | The processor will only be applied to DocumentChunks with this ContextName. |
| name | string | - | Name of this processor. The name of a processor is used only for tracing and debugging purposes. |
| dataModelState | string | - | Is this document processor managed by a data model? @enum{null,auto,customized, error}.
|
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disable the DocumentProcessor |
| precision | int | 1000 | The multiplicator. Each value will be multiplied by this factor. |
| outputContext | string | - | The ContextName used for the newly created chunk. |
| Type | Wrapper | Description |
| DocumentProcessor | fromDataModel | If dataModelState is "customized", you will find here the
original document processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| AcceptCondition | - | Expresses the enablement condition of this DocumentProcessor. |
| Name | Type | Default value | Description |
| inputContext | string | - | The processor will only be applied to DocumentChunks with this ContextName. |
| name | string | - | Name of this processor. The name of a processor is used only for tracing and debugging purposes. |
| dataModelState | string | - | Is this document processor managed by a data model? @enum{null,auto,customized, error}.
|
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disable the DocumentProcessor |
| precision | int | 6 | The number of decimals that will be used in geometrical representations and computations. |
| bboxMetaName | string | - |
| Type | Wrapper | Description |
| DocumentProcessor | fromDataModel | If dataModelState is "customized", you will find here the
original document processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| AcceptCondition | - | Expresses the enablement condition of this DocumentProcessor. |
| Name | Type | Default value | Description |
| inputContext | string | - | The processor will only be applied to DocumentChunks with this ContextName. |
| name | string | - | Name of this processor. The name of a processor is used only for tracing and debugging purposes. |
| dataModelState | string | - | Is this document processor managed by a data model? @enum{null,auto,customized, error}.
|
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disable the DocumentProcessor |
| id | string | ||
| target | string |
| Type | Wrapper | Description |
| DocumentProcessor | fromDataModel | If dataModelState is "customized", you will find here the
original document processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| AcceptCondition | - | Expresses the enablement condition of this DocumentProcessor. |
| Name | Type | Default value | Description |
| inputContext | string | - | The processor will only be applied to DocumentChunks with this ContextName. |
| name | string | - | Name of this processor. The name of a processor is used only for tracing and debugging purposes. |
| dataModelState | string | - | Is this document processor managed by a data model? @enum{null,auto,customized, error}.
|
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disable the DocumentProcessor |
| outputContext | string | - | ContextName to be associated with the DocumentChunk created for each new context. |
| pattern | string | - | Pattern used to match the substrings to replace. ASTL library is used to perform regular expression matching. The regular expression language supported is Perl 5, WITHOUT support for:
|
| value | string | - | The replacement value (sed-like output format). |
| replaceAll | boolean | True | Replaces all first occurrences of patterns. |
| Type | Wrapper | Description |
| DocumentProcessor | fromDataModel | If dataModelState is "customized", you will find here the
original document processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| AcceptCondition | - | Expresses the enablement condition of this DocumentProcessor. |
| Name | Type | Default value | Description |
| inputContext | string | - | The processor will only be applied to DocumentChunks with this ContextName. |
| name | string | - | Name of this processor. The name of a processor is used only for tracing and debugging purposes. |
| dataModelState | string | - | Is this document processor managed by a data model? @enum{null,auto,customized, error}.
|
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disable the DocumentProcessor |
| outputContext | string | - | Stores URL encoded form in outputContext. If outputContext = inputContext, it removes the original chunk. |
| encodeURIComponent | boolean | True | If true (default), it encodes the following characters: ',' '/' '?' ':' '@' '&' '=' '+' '$' '#' |
| mode | enum(encode, decode) | encode | mode = "encode" or "decode" |
| Type | Wrapper | Description |
| DocumentProcessor | fromDataModel | If dataModelState is "customized", you will find here the
original document processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| AcceptCondition | - | Expresses the enablement condition of this DocumentProcessor. |
| Name | Type | Default value | Description |
| inputContext | string | - | The processor will only be applied to DocumentChunks with this ContextName. |
| name | string | - | Name of this processor. The name of a processor is used only for tracing and debugging purposes. |
| dataModelState | string | - | Is this document processor managed by a data model? @enum{null,auto,customized, error}.
|
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disable the DocumentProcessor |
| outputContext | string | - | Stores exact/prefix/substring/suffix in outputContext. If outputContext = inputContext, it removes the original chunk. |
| exactScore | int | 4 | Specifies the score for an exact match. |
| prefixSearch | boolean | True | Enables the prefix search. |
| prefixScore | int | 3 | Specifies the score for a prefix match. |
| suffixSearch | boolean | True | Enables the suffix search. |
| suffixScore | int | 2 | Specifies the score for a suffix match. |
| substringSearch | boolean | True | Enables the substring search. |
| substringScore | int | 1 | Specifies the score for a substring match. |
| maxStringSize | int | 100 | Specifies the max string size for which this processor will be applied. |
| Type | Wrapper | Description |
| DocumentProcessor | fromDataModel | If dataModelState is "customized", you will find here the
original document processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| AcceptCondition | - | Expresses the enablement condition of this DocumentProcessor. |
| Name | Type | Default value | Description |
| inputContext | string | - | The processor will only be applied to DocumentChunks with this ContextName. |
| name | string | - | Name of this processor. The name of a processor is used only for tracing and debugging purposes. |
| dataModelState | string | - | Is this document processor managed by a data model? @enum{null,auto,customized, error}.
|
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disable the DocumentProcessor |
| outputContext | string | - | ContextName to be associated with the DocumentChunk created for each new context. |
| urlPattern | string | - | Pattern used to transform the URL. |
| Type | Wrapper | Description |
| DocumentProcessor | fromDataModel | If dataModelState is "customized", you will find here the
original document processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| AcceptCondition | - | Expresses the enablement condition of this DocumentProcessor. |
| Name | Type | Default value | Description |
| inputContext | string | - | The processor will only be applied to DocumentChunks with this ContextName. |
| name | string | - | Name of this processor. The name of a processor is used only for tracing and debugging purposes. |
| dataModelState | string | - | Is this document processor managed by a data model? @enum{null,auto,customized, error}.
|
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disable the DocumentProcessor |
| outputContext | string | - | ContextName of the chunk to create. |
| Type | Wrapper | Description |
| DocumentProcessor | fromDataModel | If dataModelState is "customized", you will find here the
original document processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| AcceptCondition | - | Expresses the enablement condition of this DocumentProcessor. |
| GeoDomain* | - |
| Name | Type | Default value | Description |
| title | string | - | |
| id | int | 0 | Unique identifier of this domain. If id=0 (its default value) the category path will be the set of vertices. Otherwise, it will be the id value. |
| radius (UI: Radius) |
double | - | Disk radius in meters |
| x | double | - | First coordinate of the center for the DiskDomain. If the point type is XY, it will be interpreted as the X coordinate (integer units). For geographic points (GPS), it will be interpreted as the latitude coordinate. |
| y | double | - | Second coordinate of the center for the DiskDomain. If the point type is XY, it will be interpreted as the Y coordinate (integer units). For geographic points (GPS), it will be interpreted as the longitude coordinate. |
| Name | Type | Default value | Description |
| title | string | - | |
| id | int | 0 | Unique identifier of this domain. If id=0 (its default value) the category path will be the set of vertices. Otherwise, it will be the id value. |
| vertices | string | - | Polygon vertices, as a list of (x,y) coordinates. For example: "0.0,0.0;1.1,0.1;1.1,1.1" |
| Name | Type | Default value | Description |
| title | string | - | |
| id | int | 0 | Unique identifier of this domain. If id=0 (its default value) the category path will be the set of vertices. Otherwise, it will be the id value. |
| resource | string | - | |
| KMZ | boolean | False | Is this resource a KMZ resource? |
| Name | Type | Default value | Description |
| title | string | - | |
| id | int | 0 | Unique identifier of this domain. If id=0 (its default value) the category path will be the set of vertices. Otherwise, it will be the id value. |
| shpResource | string | - | |
| shxResource | string | - | |
| dbfResource | string | - |
| Name | Type | Default value | Description |
| name | string | - | Name of this processor. The name of a processor is used only for tracing and debugging purposes. |
| dataModelState | string | - | Is this document processor managed by a data model? @enum{null,auto,customized, error}.
|
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disable the DocumentProcessor |
| value | string | - | New mime type |
| Type | Wrapper | Description |
| DocumentProcessor | fromDataModel | If dataModelState is "customized", you will find here the
original document processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| AcceptCondition | - | Expresses the enablement condition of this DocumentProcessor. |
| Name | Type | Default value | Description |
| name | string | - | Name of this processor. The name of a processor is used only for tracing and debugging purposes. |
| dataModelState | string | - | Is this document processor managed by a data model? @enum{null,auto,customized, error}.
|
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disable the DocumentProcessor |
| Type | Wrapper | Description |
| DocumentProcessor | fromDataModel | If dataModelState is "customized", you will find here the
original document processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| AcceptCondition | - | Expresses the enablement condition of this DocumentProcessor. |
| Name | Type | Default value | Description |
| name | string | - | Name of this processor. The name of a processor is used only for tracing and debugging purposes. |
| dataModelState | string | - | Is this document processor managed by a data model? @enum{null,auto,customized, error}.
|
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disable the DocumentProcessor |
| path | string | - | User defined path to a Java file containing the processor code |
| priority | int | - | Defines which path to use (0: user defined path, 1: resource managed path (inlined Java)) |
| sourceCode | string | - | Inline Java code |
| Type | Wrapper | Description |
| DocumentProcessor | fromDataModel | If dataModelState is "customized", you will find here the
original document processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| AcceptCondition | - | Expresses the enablement condition of this DocumentProcessor. |
| Name | Type | Default value | Description |
| name | string | - | Name of this processor. The name of a processor is used only for tracing and debugging purposes. |
| dataModelState | string | - | Is this document processor managed by a data model? @enum{null,auto,customized, error}.
|
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disable the DocumentProcessor |
| path | string | - | User defined path to a JS file containing the processor code |
| priority | int | - | Defines which path to use (0: user defined path, 1: resource managed path (inlined JS)) |
| script | string | - | Inline script |
| Type | Wrapper | Description |
| DocumentProcessor | fromDataModel | If dataModelState is "customized", you will find here the
original document processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| AcceptCondition | - | Expresses the enablement condition of this DocumentProcessor. |
| Name | Type | Default value | Description |
| name | string | - | Name of this processor. The name of a processor is used only for tracing and debugging purposes. |
| dataModelState | string | - | Is this document processor managed by a data model? @enum{null,auto,customized, error}.
|
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disable the DocumentProcessor |
| instance | string | - | Storage service instance |
| metaIdentifier | string | - | Defines an optional meta name that will be used as storage Identifier instead of the document Uri. |
| Type | Wrapper | Description |
| DocumentProcessor | fromDataModel | If dataModelState is "customized", you will find here the
original document processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| AcceptCondition | - | Expresses the enablement condition of this DocumentProcessor. |
| Name | Type | Default value | Description |
| name | string | - | Name of this processor. The name of a processor is used only for tracing and debugging purposes. |
| dataModelState | string | - | Is this document processor managed by a data model? @enum{null,auto,customized, error}.
|
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disable the DocumentProcessor |
| expression | string | - | Arithmetic expression to evaluate. For example: "$file_size + 42" |
| outputContext | string | - | ContextName of the chunk to create. |
| floatingPoint | boolean | False | Output: A floating point number instead of the default integer one. |
| Type | Wrapper | Description |
| DocumentProcessor | fromDataModel | If dataModelState is "customized", you will find here the
original document processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| AcceptCondition | - | Expresses the enablement condition of this DocumentProcessor. |
| Name | Type | Default value | Description |
| name | string | - | Name of this processor. The name of a processor is used only for tracing and debugging purposes. |
| dataModelState | string | - | Is this document processor managed by a data model? @enum{null,auto,customized, error}.
|
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disable the DocumentProcessor |
| convertAddresses | string | - | Semicolon separated list of convert instance names or urls to use. |
| Type | Wrapper | Description |
| DocumentProcessor | fromDataModel | If dataModelState is "customized", you will find here the
original document processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| AcceptCondition | - | Expresses the enablement condition of this DocumentProcessor. |
| Name | Type | Default value | Description |
| name | string | - | Name of this processor. The name of a processor is used only for tracing and debugging purposes. |
| dataModelState | string | - | Is this document processor managed by a data model? @enum{null,auto,customized, error}.
|
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disable the DocumentProcessor |
| Type | Wrapper | Description |
| DocumentProcessor | fromDataModel | If dataModelState is "customized", you will find here the
original document processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| AlertGroup* | alertGroups | List of alert groups handled by this processor, empty means ALL groups |
| CustomPublisher* | customPublishers | |
| AcceptCondition | - | Expresses the enablement condition of this DocumentProcessor. |
| Name | Type | Default value | Description |
| name | string | - |
| Name | Type | Default value | Description |
| classId | string | - | Custom publisher type |
| Type | Wrapper | Description |
| KeyValue* | config |
| Name | Type | Default value | Description |
| name | string | - | Name of this processor. The name of a processor is used only for tracing and debugging purposes. |
| dataModelState | string | - | Is this document processor managed by a data model? @enum{null,auto,customized, error}.
|
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disable the DocumentProcessor |
| defaultValue | string | - | Default mime to use if not detected. |
| defaultCharset | string | - | On text or HTML files, the MIME detector tries to detect charset encoding automatically. If the encoding cannot be detected, this 'defaultCharset' is used. |
| Type | Wrapper | Description |
| DocumentProcessor | fromDataModel | If dataModelState is "customized", you will find here the
original document processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| AcceptCondition | - | Expresses the enablement condition of this DocumentProcessor. |
| Name | Type | Default value | Description |
| name | string | - | Name of this processor. The name of a processor is used only for tracing and debugging purposes. |
| dataModelState | string | - | Is this document processor managed by a data model? @enum{null,auto,customized, error}.
|
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disable the DocumentProcessor |
| annotateHTML | boolean | False | Adds some stylish annotations to DocumentChunks (for HTML files only):
It also creates specific HTML DocumentChunks with the following contexts:
|
| skipInvisibleHTMLText | boolean | False | Skips the invisible text. For example, white fonts on white backgrounds (for HTML files only). |
| extractJs | boolean | False | Tries to parse JavaScript and then extract links. |
| extractHTMLTables | boolean | False | Adds annotations on table, tr, td, th |
| extractHTMLStyles | boolean | False | Adds annotations on style attributes. |
| extractHTMLForms | boolean | False | Add annotations on Forms, select. |
| maxHTMLAnnotationDepth | int | 20 | Prevents new annotations from being created after @c maxHTMLAnnotationDepth HTML level. |
| disableAutomaticHTMLDTDFix | boolean | False | Disables automatic DTD fix on HTML documents. |
| Type | Wrapper | Description |
| DocumentProcessor | fromDataModel | If dataModelState is "customized", you will find here the
original document processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| AcceptCondition | - | Expresses the enablement condition of this DocumentProcessor. |
| Name | Type | Default value | Description |
| name | string | - | Name of this processor. The name of a processor is used only for tracing and debugging purposes. |
| dataModelState | string | - | Is this document processor managed by a data model? @enum{null,auto,customized, error}.
|
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disable the DocumentProcessor |
| looseTextDetection | boolean | True | Looses text detection to detect more text files, including suspicious ones (not *.txt or *.html) ("true", "false") |
| forceContent | boolean | False | Forces to accept the content, even if the MIME type does not seem to be a known or supported MIME type. |
| minInputSizeKB | long | -1 | Minimum document size accepted, in kilobytes. |
| maxInputSizeKB | long | -1 | Maximum document size accepted, in kilobytes. |
| maxRecursionDepth | int | -1 | Maximum recursion depth. |
| maxRecursionDocuments | int | -1 | Maximum number of documents that can be converted in one directory level. |
| maxRecursionDocumentsTotal | int | -1 | Maximum number of documents that can be converted over all levels. |
| strictSizeCheck | boolean | False | Strict size validation mode (even for partial reads). |
| retryIO | string | - | Uses regular I/O when mmap fails. ("true", "false") |
| filter | string | - | Native filter identifier list to be used specifically. The list is a comma-separated (,) list of filter identifiers with optional ending argument(s) separated by semi-colons (;). If the filter identifier is prefixed by '!', the corresponding filter will be explicitly excluded. The special filter identifier '*' stands for "all other filters". First match wins: "*,!doc" is identical to "*". For example: filter="!jpeg,*" will accept all filters but the jpeg filter. |
| timeoutMs | long | -1 | Conversion timeout value, in milliseconds. If the conversion process takes longer, the remote side attemps to abort the conversion process. |
| priority | string | - | Worker thread(s) priority to be used for the processing ("normal", "lowest", "very low", "low", "normal", "high", "very high") |
| embedded | string | - | Includes embedded images ("true", "false", "optional") |
| attachments | string | - | Includes embedded attachments ("true", "false", "optional") |
| styles | string | - | Attempts to extract more text styles for HTML conversion ("true", "false", "optional") |
| forceConversion | boolean | False | Attempts to generate an empty document upon conversion error (may be ignored) |
| startPage | long | -1 | Starts conversion from this page number (page number starts at 1). This parameter is only taken into account for image processing and may be ignored. |
| maxPages | long | -1 | Maximum number of pages to process for xml conversion (may be ignored). |
| maxOutputSizeKB | long | -1 | Maximum output size on the remote side, in kilobytes. If the generated output exceeds this value, the document may be truncated or invalid. |
| allowUnicode32 | boolean | False | Allows the use of 32-bit unicode points. |
| allowDocumentChars | boolean | False | Allows the use of Unicode private range characters (E0XX) for separators (keyword, sentence, paragraph separators, ...) |
| outsideIn | string | - | This feature is no longer supported. ("true", "false", "optional") |
| outsideInFallback | string | - | This feature is no longer supported. ("true", "false", "optional") |
| outsideInOnly | string | - | This feature is no longer supported. ("true", "false", "optional") |
| outsideInForPreview | string | - | This feature is no longer supported. ("true", "false", "optional") |
| outsideInSimpleXHTMLFallback | string | - | This feature is no longer supported. ("true", "false", "optional") |
| ocr | string | - | Converts using OCR ("true", "false", "optional") |
| ocrFallback | string | - | Fallback to OCR if heuristics deem it necessary ("true", "false", "optional") |
| ocrDetect | string | - | Detects documents requiring OCR (and rejects them) ("true", "false") |
| ocrQuality | string | - | OCR quality ("fast", "normal", "best") |
| ocrLang | string | - | OCR language(s) ("en" for English, "en;fr" for French and English, etc.) |
| ocrTimeoutMs | long | -1 | OCR conversion timeout value, in milliseconds. If the OCR process takes longer, the remote side attemps to abort the conversion process. This value overrides the timeout value if the processing involves an OCR operation. |
| ocrMaxPages | int | -1 | Maximum number of pages to process for OCR. |
| ocrPriority | string | - | Worker thread(s) priority to be used for the OCR processing ("normal", "lowest", "very low", "low", "normal", "high", "very high") |
| httpProxyUrl | string | - | Optional HTTP proxy URL. The URL can embed credentials if required. |
| disablePlugins | boolean | False | Disables external plugins. |
| overrideAddresses | string | - |
| Type | Wrapper | Description |
| DocumentProcessor | fromDataModel | If dataModelState is "customized", you will find here the
original document processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| AcceptCondition | - | Expresses the enablement condition of this DocumentProcessor. |
| KeyValue* | - |
| Name | Type | Default value | Description |
| name | string | - | Name of this processor. The name of a processor is used only for tracing and debugging purposes. |
| dataModelState | string | - | Is this document processor managed by a data model? @enum{null,auto,customized, error}.
|
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disable the DocumentProcessor |
| remoteUrl | string | - | Remote URL |
| timeoutMs | int | - | Remote processor timeout, in milliseconds. This is the timeout. |
| httpIdleTimeoutMs | int | - | Cached HTTP connection idle timeout. This is an advanced setting. For efficiency, the RemoteHTTPTransformer maintains a pool of opened connections to the remote HTTP service. This defines the timeout for connections which are no longer used. Default is 10.000. |
| Type | Wrapper | Description |
| DocumentProcessor | fromDataModel | If dataModelState is "customized", you will find here the
original document processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| RemoteHTTPTransformerRemoteArgMapping* | argMapping | Argument(s) mapping, if any. @see RemoteHTTPTransformerRemoteArgMapping |
| AcceptCondition | - | Expresses the enablement condition of this DocumentProcessor. |
| Name | Type | Default value | Description |
| key | string | - | URL key to map. This key name will be used as remote HTTP argument name. |
| value | string | - | Value to use. If @c null, the @c defaultValue value will be used. The following values names are reserved:
|
| defaultValue | string | - | Value to use if the @c value is @c null. If this value is @c null, the empty string will be used. |
| Name | Type | Default value | Description |
| name | string | - | Name of this processor. The name of a processor is used only for tracing and debugging purposes. |
| dataModelState | string | - | Is this document processor managed by a data model? @enum{null,auto,customized, error}.
|
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disable the DocumentProcessor |
| masterPart | string | - | Name of the master part. This name should be "master" to follow the convention used by connectors that send documents composed of multiple parts (e.g. mails with attachments). |
| Type | Wrapper | Description |
| DocumentProcessor | fromDataModel | If dataModelState is "customized", you will find here the
original document processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| StringValue* | partSpecificContexts | The ContextNames of the DocumentChunk from the non-master part that should be copied to the root document. |
| AcceptCondition | - | Expresses the enablement condition of this DocumentProcessor. |
| Name | Type | Default value | Description |
| name | string | - | Name of this processor. The name of a processor is used only for tracing and debugging purposes. |
| dataModelState | string | - | Is this document processor managed by a data model? @enum{null,auto,customized, error}.
|
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disable the DocumentProcessor |
| pipeline | string | - | Analysis pipeline on which semantic processors will be used. |
| annotations | string | - | A chunk will be created for each annotation which name is in the list. Comma-separated list of annotations. |
| topLevelAnnotationsOnly | boolean | False | Considers top level annotations only. For example, results from the QueryMatcher or Fast Rules. |
| Type | Wrapper | Description |
| DocumentProcessor | fromDataModel | If dataModelState is "customized", you will find here the
original document processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| AcceptCondition | - | Expresses the enablement condition of this DocumentProcessor. |
| SemanticProcessor* | - | List of semantic processors to use |
| Name | Type | Default value | Description |
| name | string | - | Name of the Semantic Processor. This name is only used for tracing and debugging purposes. |
| contexts | string | - | Comma-separated list of the ContextNames of the Document Chunks on which this processor should be applied. If this list is empty, all DocumentChunks are processed. |
| dataModelState | string | - | Is this semantic processor managed by a data model? @enum{null,auto,customized, error}. If null, this semantic processor is not related to the data model. If "auto", this semantic processor is auto-generated by the data model. |
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disables the DocumentProcessor |
| tagsToAnchor | string | - | List of comma-separated tags on which to work |
| finalAnnotationOnNextToken | boolean | False | If true, sets final annotation on the token after the last token of annotation a |
| finalCannotBeSepSpace | boolean | False | If final can't be a space, the annotation last may be set on the next non-blank token |
| Type | Wrapper | Description |
| SemanticProcessor | fromDataModel | If dataModelState is "customized", you will find here the original semantic processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| Name | Type | Default value | Description |
| name | string | - | Name of the Semantic Processor. This name is only used for tracing and debugging purposes. |
| contexts | string | - | Comma-separated list of the ContextNames of the Document Chunks on which this processor should be applied. If this list is empty, all DocumentChunks are processed. |
| dataModelState | string | - | Is this semantic processor managed by a data model? @enum{null,auto,customized, error}. If null, this semantic processor is not related to the data model. If "auto", this semantic processor is auto-generated by the data model. |
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disables the DocumentProcessor |
| tokenizeAnnotations | boolean | True | Subtokenizes "SearchServer" into "Search" "Server" automatically, and keep original annotations. |
| doCamelCase | boolean | True | Separates compound words before each capital letter. For example, the annotation for "CamelCase" is compound="camel case". |
| doUnderscore | boolean | True | Separates multi-word strings wherever there is an underscore. For example, the annotation for "under_score" is compound="under score". |
| Type | Wrapper | Description |
| SemanticProcessor | fromDataModel | If dataModelState is "customized", you will find here the original semantic processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| Name | Type | Default value | Description |
| name | string | - | Name of the Semantic Processor. This name is only used for tracing and debugging purposes. |
| contexts | string | - | Comma-separated list of the ContextNames of the Document Chunks on which this processor should be applied. If this list is empty, all DocumentChunks are processed. |
| dataModelState | string | - | Is this semantic processor managed by a data model? @enum{null,auto,customized, error}. If null, this semantic processor is not related to the data model. If "auto", this semantic processor is auto-generated by the data model. |
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disables the DocumentProcessor |
| enableApproxMatching | boolean | False | Enables approximative matching in ontology. Approximative matching uses the Damerau-Levenshtein edit distance. |
| minWordSizeForDist1 | int | 3 | Minimum number of chars in token to enable the Damerau-Levenshtein distance of 1. |
| minWordSizeForDist2 | int | 8 | Minimum number of chars in token to enable the Damerau-Levenshtein distance of 2. |
| resourceDir | string | - | URL for the directory containing the ontology (data://, file;// or resource://). |
| restrictLanguage | boolean | True | Keeps only the expression added with language == Language.XX or with the document language. For example, if the Ontology contains an expression added with language=En, it will be extracted only for an English document if restrictLanguage is set to true. |
| keepLongestMatch | boolean | True | Keeps only the longest match. For example, if you have 5 tokens ('a', 'b', 'c', 'd', 'e') and 4 annotations 'a', 'a-c', 'b-c-d' and 'd-e', this option will only keep 'b-c-d' and remove all other annotations. |
| keepLongestMatchInterTag | boolean | False | Keeps only the longest match (tag independant). For example, if you have 5 tokens ('a', 'b', 'c', 'd', 'e') and 4 annotations 'a', 'a-c', 'b-c-d' and 'd-e', this option will only keep 'b-c-d' and remove all other annotations. |
| tokenizeAnnotations | boolean | False | If you have some multi-tokens annotations (like "super market" annotation on token "supermarket", this option will automatically subtokenize "supermarket" in "super" "market" and keep original annotations. If you enable this option, keepLongestMatch and keepLongestMatcherInterTag will be set to true. |
| annotationsToIgnore | string | - | Sets the list of annotations to be ignored (comma-separated). This feature allows you to define a list of words/expressions to ignore in the recognition of this ontology. For example, if you add:
|
| ignoreSpaces | boolean | False | If your ontology was compiled with matchOnSeparators=false, this allows 'lemonde' to retrieve 'le monde' or 'le monde' to retrieve 'lemonde'. If your ontology was compiled with matchOnSeparators=true, this allows 'le monde' to retrieve 'le monde'. |
| annotationPrefix | string | A prefix to add to each annotation tag. For example, if the package of the entry matched in the ontology is "exalead.location.country" and the annotationPrefix is "myOntology_", an annotation will be added with the tag "myOntology_exalead.location.country". |
|
| trustLevelBasedDedup | boolean | False | Keeps only the annotation with the highest trust level when several entries from a package match the same text chunk. |
| Type | Wrapper | Description |
| SemanticProcessor | fromDataModel | If dataModelState is "customized", you will find here the original semantic processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
NE.person or NE.organization, using ontology-based matching and/or rule-based matching.
| Name | Type | Default value | Description |
| name | string | - | Name of the Semantic Processor. This name is only used for tracing and debugging purposes. |
| contexts | string | - | Comma-separated list of the ContextNames of the Document Chunks on which this processor should be applied. If this list is empty, all DocumentChunks are processed. |
| dataModelState | string | - | Is this semantic processor managed by a data model? @enum{null,auto,customized, error}. If null, this semantic processor is not related to the data model. If "auto", this semantic processor is auto-generated by the data model. |
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disables the DocumentProcessor |
| resourceDir | string | - | URL for the resource (data://, file;// or resource://). |
| rules | string | ne | Defines which entities will be extracted:
|
| prefix | string | NE | Prefix to add in front of each annotation generated by the named entity matcher. |
| language | string | - | Languages for which the processor is activated; if no language is specified, the processor is activated for all languages. |
| partOfSpeechFiltering | boolean | True | It discards annotations for parts of text made of a name followed by a verb or an adverb with the first letter in uppercase. This filter is useful if your documents contain a lot of titles with several capitalized words (what is called 'Title Case'). It applies to NE.person, NE.place and NE.organization. |
| useKnownWordsForDisambiguisation | boolean | True | Uses a resource of known words to disambiguate named entities candidates. It works only for English and French. |
| Type | Wrapper | Description |
| SemanticProcessor | fromDataModel | If dataModelState is "customized", you will find here the original semantic processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| Name | Type | Default value | Description |
| name | string | - | Name of the Semantic Processor. This name is only used for tracing and debugging purposes. |
| contexts | string | - | Comma-separated list of the ContextNames of the Document Chunks on which this processor should be applied. If this list is empty, all DocumentChunks are processed. |
| dataModelState | string | - | Is this semantic processor managed by a data model? @enum{null,auto,customized, error}. If null, this semantic processor is not related to the data model. If "auto", this semantic processor is auto-generated by the data model. |
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disables the DocumentProcessor |
| resourceDir | string | - | URL for the vocabulary resource (data://, file;// or resource://) |
| annotationName | string | - | Name of the annotation to add. |
| language | iso code | - | Language for which the vocabulary classifier is activated. |
| excludedLanguages | string | Language for which the vocabulary classifier is deactivated (works only if language=xx, comma-separated). | |
| addAnnotationsOnKeywords | boolean | False | If true, it adds annotations to all matching tokens. |
| maxAnnotations | int | -1 | Maximum number of annotations per document. |
| minTrustLevel | int | 0 | The minimum trust level of categories to keep. |
| maxKeywords | int | -1 | The maximum number of keywords to keep. |
| minKeywords | int | 1 | The minimum number of keywords per class. |
| collapseToken | boolean | False | If true, all identical tokens are collapsed. |
| extraPrefixAnnotations | string | The optional list of prefix annotations to keep (comma-separated). | |
| extraAnnotationsMinTrustLevel | int | 100 | The minimum trust level to keep an extra annotation. |
| Type | Wrapper | Description |
| SemanticProcessor | fromDataModel | If dataModelState is "customized", you will find here the original semantic processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| Name | Type | Default value | Description |
| resourceDir | string | - | URL for the vocabulary resource (data://, file;// or resource://) |
| annotationName | string | - | Name of the annotation to add. |
| language | iso code | - | Language for which the vocabulary classifier is activated. |
| excludedLanguages | string | Language for which the vocabulary classifier is deactivated (works only if language=xx, comma-separated). | |
| addAnnotationsOnKeywords | boolean | False | If true, it adds annotations to all matching tokens. |
| maxAnnotations | int | -1 | Maximum number of annotations per document. |
| minTrustLevel | int | 0 | The minimum trust level of categories to keep. |
| maxKeywords | int | -1 | The maximum number of keywords to keep. |
| minKeywords | int | 1 | The minimum number of keywords per class. |
| collapseToken | boolean | False | If true, all identical tokens are collapsed. |
| extraPrefixAnnotations | string | The optional list of prefix annotations to keep (comma-separated). | |
| extraAnnotationsMinTrustLevel | int | 100 | The minimum trust level to keep an extra annotation. |
| name | string | - | Name of the Semantic Processor. This name is only used for tracing and debugging purposes. |
| contexts | string | - | Comma-separated list of the ContextNames of the Document Chunks on which this processor should be applied. If this list is empty, all DocumentChunks are processed. |
| dataModelState | string | - | Is this semantic processor managed by a data model? @enum{null,auto,customized, error}. If null, this semantic processor is not related to the data model. If "auto", this semantic processor is auto-generated by the data model. |
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disables the DocumentProcessor |
| Type | Wrapper | Description |
| SemanticProcessor | fromDataModel | If dataModelState is "customized", you will find here the original semantic processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| Name | Type | Default value | Description |
| name | string | - | Name of the Semantic Processor. This name is only used for tracing and debugging purposes. |
| contexts | string | - | Comma-separated list of the ContextNames of the Document Chunks on which this processor should be applied. If this list is empty, all DocumentChunks are processed. |
| dataModelState | string | - | Is this semantic processor managed by a data model? @enum{null,auto,customized, error}. If null, this semantic processor is not related to the data model. If "auto", this semantic processor is auto-generated by the data model. |
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disables the DocumentProcessor |
| resourceFile | string | - | URL for the resource (data://, file;// or resource://). |
| language | iso code | - | Language for which this processor is activated. |
| Type | Wrapper | Description |
| SemanticProcessor | fromDataModel | If dataModelState is "customized", you will find here the original semantic processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| Name | Type | Default value | Description |
| name | string | - | Name of the Semantic Processor. This name is only used for tracing and debugging purposes. |
| contexts | string | - | Comma-separated list of the ContextNames of the Document Chunks on which this processor should be applied. If this list is empty, all DocumentChunks are processed. |
| dataModelState | string | - | Is this semantic processor managed by a data model? @enum{null,auto,customized, error}. If null, this semantic processor is not related to the data model. If "auto", this semantic processor is auto-generated by the data model. |
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disables the DocumentProcessor |
| relatedTermsMinSpan | int | 3 | Minimum number of words (excluding stop words) in an automatically extracted term (not applicable to allow list). |
| relatedTermsMaxSpan | int | 6 | Maximum number of words (excluding stop words) in an automatically extracted term (not applicable to allow list). |
| maxRelatedTermsPerDoc | int | 64 | The maximum number of related terms per document. |
| keepLongestMatch | boolean | True | Keeps only the longest term when several overlap. For example, if you have 5 tokens ('a', 'b', 'c', 'd', 'e') and 4 related terms 'a', 'a-c', 'b-c-d' and 'd-e', this option will only keep 'b-c-d' and remove all other related terms. |
| dictionaryName | string | - | Name of the dictionary populated by terms extracted by this processor. If null, use the default dictionary. |
| preprocResourceDir | string | - | URL for the resource of the related terms preprocessor (data://, file;// or resource://). If null, we use the standard preprocessor of the product. |
| whitelistResource | string | - | Path to a related terms allow list resource. |
| blacklistResource | string | - | Path to a related terms blocklist resource. |
| withPartOfSpeech | boolean | True | Adds a PartOfSpeechTagger to the list of processors automatically. Improves quality of automatically extracted terms. |
| Type | Wrapper | Description |
| SemanticProcessor | fromDataModel | If dataModelState is "customized", you will find here the original semantic processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| Name | Type | Default value | Description |
| name | string | - | Name of the Semantic Processor. This name is only used for tracing and debugging purposes. |
| contexts | string | - | Comma-separated list of the ContextNames of the Document Chunks on which this processor should be applied. If this list is empty, all DocumentChunks are processed. |
| dataModelState | string | - | Is this semantic processor managed by a data model? @enum{null,auto,customized, error}. If null, this semantic processor is not related to the data model. If "auto", this semantic processor is auto-generated by the data model. |
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disables the DocumentProcessor |
| resourceDir | string | - | URL for the resource (data://, file;// or resource://). |
| language | string | - | Languages for which the processor is activated; if no language is specified, the processor is activated for all languages. |
| Type | Wrapper | Description |
| SemanticProcessor | fromDataModel | If dataModelState is "customized", you will find here the original semantic processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| Name | Type | Default value | Description |
| name | string | - | Name of the Semantic Processor. This name is only used for tracing and debugging purposes. |
| contexts | string | - | Comma-separated list of the ContextNames of the Document Chunks on which this processor should be applied. If this list is empty, all DocumentChunks are processed. |
| dataModelState | string | - | Is this semantic processor managed by a data model? @enum{null,auto,customized, error}. If null, this semantic processor is not related to the data model. If "auto", this semantic processor is auto-generated by the data model. |
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disables the DocumentProcessor |
| resourceFile | string | - | URL for the resource (data://, file;// or resource://). |
| language | string | - | Languages for which the processor is activated; if no language is specified, the processor is activated for all languages. |
| Type | Wrapper | Description |
| SemanticProcessor | fromDataModel | If dataModelState is "customized", you will find here the original semantic processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| Name | Type | Default value | Description |
| name | string | - | Name of the Semantic Processor. This name is only used for tracing and debugging purposes. |
| contexts | string | - | Comma-separated list of the ContextNames of the Document Chunks on which this processor should be applied. If this list is empty, all DocumentChunks are processed. |
| dataModelState | string | - | Is this semantic processor managed by a data model? @enum{null,auto,customized, error}. If null, this semantic processor is not related to the data model. If "auto", this semantic processor is auto-generated by the data model. |
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disables the DocumentProcessor |
| min | int | 2 | Minimum ngram size |
| max | int | 3 | Maximum ngram size |
| Type | Wrapper | Description |
| SemanticProcessor | fromDataModel | If dataModelState is "customized", you will find here the original semantic processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| Name | Type | Default value | Description |
| name | string | - | Name of the Semantic Processor. This name is only used for tracing and debugging purposes. |
| contexts | string | - | Comma-separated list of the ContextNames of the Document Chunks on which this processor should be applied. If this list is empty, all DocumentChunks are processed. |
| dataModelState | string | - | Is this semantic processor managed by a data model? @enum{null,auto,customized, error}. If null, this semantic processor is not related to the data model. If "auto", this semantic processor is auto-generated by the data model. |
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disables the DocumentProcessor |
| resourceDir | string | - | URL for the resource (data://, file;// or resource://). |
| language | string | - | Languages for which the processor is activated; if no language is specified, the processor is activated for all languages. |
| lemmatizeNormalizedAnnotations | boolean | False |
| Type | Wrapper | Description |
| SemanticProcessor | fromDataModel | If dataModelState is "customized", you will find here the original semantic processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| Name | Type | Default value | Description |
| name | string | - | Name of the Semantic Processor. This name is only used for tracing and debugging purposes. |
| contexts | string | - | Comma-separated list of the ContextNames of the Document Chunks on which this processor should be applied. If this list is empty, all DocumentChunks are processed. |
| dataModelState | string | - | Is this semantic processor managed by a data model? @enum{null,auto,customized, error}. If null, this semantic processor is not related to the data model. If "auto", this semantic processor is auto-generated by the data model. |
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disables the DocumentProcessor |
| addNormalizerAnnotation | boolean | False | |
| separators | string | - | List of allowed separators chars separated by ',' (can only be alphanumerical, for example, 'and' to handle '1 and 1') |
| language | string | - | Languages for which the processor is activated; if no language is specified, the processor is activated for all languages. |
| strict | boolean | True | In strict mode, the only separator is dot. |
| Type | Wrapper | Description |
| SemanticProcessor | fromDataModel | If dataModelState is "customized", you will find here the original semantic processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| Name | Type | Default value | Description |
| name | string | - | Name of the Semantic Processor. This name is only used for tracing and debugging purposes. |
| contexts | string | - | Comma-separated list of the ContextNames of the Document Chunks on which this processor should be applied. If this list is empty, all DocumentChunks are processed. |
| dataModelState | string | - | Is this semantic processor managed by a data model? @enum{null,auto,customized, error}. If null, this semantic processor is not related to the data model. If "auto", this semantic processor is auto-generated by the data model. |
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disables the DocumentProcessor |
| inputTags | string | - | Normalize all tags of "inputTags" (comma-separated list of tags). |
| trustLevel | int | 100 | |
| transliteration | boolean | True | When normalizing, convert some characters to their latin equivalent |
| Type | Wrapper | Description |
| SemanticProcessor | fromDataModel | If dataModelState is "customized", you will find here the original semantic processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| Name | Type | Default value | Description |
| name | string | - | Name of the Semantic Processor. This name is only used for tracing and debugging purposes. |
| contexts | string | - | Comma-separated list of the ContextNames of the Document Chunks on which this processor should be applied. If this list is empty, all DocumentChunks are processed. |
| dataModelState | string | - | Is this semantic processor managed by a data model? @enum{null,auto,customized, error}. If null, this semantic processor is not related to the data model. If "auto", this semantic processor is auto-generated by the data model. |
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disables the DocumentProcessor |
| startOffset | int | 8192 | |
| annotation | string | fartext |
| Type | Wrapper | Description |
| SemanticProcessor | fromDataModel | If dataModelState is "customized", you will find here the original semantic processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| Name | Type | Default value | Description |
| name | string | - | Name of the Semantic Processor. This name is only used for tracing and debugging purposes. |
| contexts | string | - | Comma-separated list of the ContextNames of the Document Chunks on which this processor should be applied. If this list is empty, all DocumentChunks are processed. |
| dataModelState | string | - | Is this semantic processor managed by a data model? @enum{null,auto,customized, error}. If null, this semantic processor is not related to the data model. If "auto", this semantic processor is auto-generated by the data model. |
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disables the DocumentProcessor |
| resourceDir | string | - | URL for the resource (data://, file;// or resource://). |
| language | string | - | Languages for which the processor is activated; if no language is specified, the processor is activated for all languages. |
| Type | Wrapper | Description |
| SemanticProcessor | fromDataModel | If dataModelState is "customized", you will find here the original semantic processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| Name | Type | Default value | Description |
| name | string | - | Name of the Semantic Processor. This name is only used for tracing and debugging purposes. |
| contexts | string | - | Comma-separated list of the ContextNames of the Document Chunks on which this processor should be applied. If this list is empty, all DocumentChunks are processed. |
| dataModelState | string | - | Is this semantic processor managed by a data model? @enum{null,auto,customized, error}. If null, this semantic processor is not related to the data model. If "auto", this semantic processor is auto-generated by the data model. |
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disables the DocumentProcessor |
| resourceDir | string | - | URL for the resource (data://, file;// or resource://). |
| language | iso code | - | |
| annotateGlobally | boolean | False | |
| annotatePronouns | boolean | False | |
| ignorePartOfSpeech | boolean | False | |
| ignoreRelatedTerms | boolean | False | |
| legacyAnnotations | boolean | False | |
| notApplicableAnnotations | boolean | True | |
| normalizeTrustLevels | boolean | True | |
| nounPackage | boolean | True | |
| packageCount | boolean | False | |
| showPackage | boolean | False | |
| suggest | boolean | False | |
| summarize | boolean | False | |
| suggestOutput | string | - |
| Type | Wrapper | Description |
| SemanticProcessor | fromDataModel | If dataModelState is "customized", you will find here the original semantic processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| Name | Type | Default value | Description |
| name | string | - | Name of the Semantic Processor. This name is only used for tracing and debugging purposes. |
| contexts | string | - | Comma-separated list of the ContextNames of the Document Chunks on which this processor should be applied. If this list is empty, all DocumentChunks are processed. |
| dataModelState | string | - | Is this semantic processor managed by a data model? @enum{null,auto,customized, error}. If null, this semantic processor is not related to the data model. If "auto", this semantic processor is auto-generated by the data model. |
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disables the DocumentProcessor |
| resourceDir | string | - | Directory containing the matcher resources. Must not be empty. |
| allowsExprStartingBySeparators | boolean | False | If you have expressions starting with a separator (",", ";", "&", ...), then you must set this option to true. |
| Type | Wrapper | Description |
| SemanticProcessor | fromDataModel | If dataModelState is "customized", you will find here the original semantic processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| Name | Type | Default value | Description |
| name | string | - | Name of the Semantic Processor. This name is only used for tracing and debugging purposes. |
| contexts | string | - | Comma-separated list of the ContextNames of the Document Chunks on which this processor should be applied. If this list is empty, all DocumentChunks are processed. |
| dataModelState | string | - | Is this semantic processor managed by a data model? @enum{null,auto,customized, error}. If null, this semantic processor is not related to the data model. If "auto", this semantic processor is auto-generated by the data model. |
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disables the DocumentProcessor |
| Type | Wrapper | Description |
| SemanticProcessor | fromDataModel | If dataModelState is "customized", you will find here the original semantic processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| Name | Type | Default value | Description |
| name | string | - | Name of the Semantic Processor. This name is only used for tracing and debugging purposes. |
| contexts | string | - | Comma-separated list of the ContextNames of the Document Chunks on which this processor should be applied. If this list is empty, all DocumentChunks are processed. |
| dataModelState | string | - | Is this semantic processor managed by a data model? @enum{null,auto,customized, error}. If null, this semantic processor is not related to the data model. If "auto", this semantic processor is auto-generated by the data model. |
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disables the DocumentProcessor |
| outputFile | string | - | |
| format | enum(html, xml) | html | Output format. |
| Type | Wrapper | Description |
| SemanticProcessor | fromDataModel | If dataModelState is "customized", you will find here the original semantic processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| Name | Type | Default value | Description |
| name | string | - | Name of the Semantic Processor. This name is only used for tracing and debugging purposes. |
| contexts | string | - | Comma-separated list of the ContextNames of the Document Chunks on which this processor should be applied. If this list is empty, all DocumentChunks are processed. |
| dataModelState | string | - | Is this semantic processor managed by a data model? @enum{null,auto,customized, error}. If null, this semantic processor is not related to the data model. If "auto", this semantic processor is auto-generated by the data model. |
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disables the DocumentProcessor |
| resourceDir | string | - | URL for the resource (data://, file:// or resource://) |
| breakOnSentence | boolean | False | If true, there will be maximum one match per sentence, and no match for inter-sentence. This option will add the SentenceFinder automatically. |
| breakOnParagraph | boolean | True | If true, there will be maximum one match per paragraph, and no match for inter-paragraph. |
| breakOnLine | boolean | False | If true, there will be maximum one match per line, and no match for inter-line. |
| matchAllRules | boolean | True | If true, it returns the full list of matched rules. If false, it returns the first matched rule only. |
| Type | Wrapper | Description |
| SemanticProcessor | fromDataModel | If dataModelState is "customized", you will find here the original semantic processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| Name | Type | Default value | Description |
| name | string | - | Name of the Semantic Processor. This name is only used for tracing and debugging purposes. |
| contexts | string | - | Comma-separated list of the ContextNames of the Document Chunks on which this processor should be applied. If this list is empty, all DocumentChunks are processed. |
| dataModelState | string | - | Is this semantic processor managed by a data model? @enum{null,auto,customized, error}. If null, this semantic processor is not related to the data model. If "auto", this semantic processor is auto-generated by the data model. |
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disables the DocumentProcessor |
| resourceDir | string | - | URL of the compiled semantic extractor file. Use the format data://, file:// or resource://. |
| prefix | string | - | Output annotations prefix |
| breakOnSentence | boolean | False | If true, there will be maximum one match per sentence, and no match for inter-sentence. This option will add the SentenceFinder automatically. |
| breakOnParagraph | boolean | True | If true, there will be maximum one match per paragraph, and no match for inter-paragraph. |
| breakOnLine | boolean | False | If true, there will be maximum one match per line, and no match for inter-line. |
| matchAllRules | boolean | True | If true, it returns the full list of matched rules. If false, it returns only the first matched rule. |
| language | iso code | - | Language for which the extractor is activated. If null, all languages are activated. |
| annotateUnusedTokensWith | string | - | Used in the context of query rewriting by the Semantic Query Analyzer. |
| overlappingMatches | boolean | True | If true, reports all matches even if their locations overlap. Only makes sense when matchAllRules is true. |
| Type | Wrapper | Description |
| SemanticProcessor | fromDataModel | If dataModelState is "customized", you will find here the original semantic processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| Name | Type | Default value | Description |
| name | string | - | Name of the Semantic Processor. This name is only used for tracing and debugging purposes. |
| contexts | string | - | Comma-separated list of the ContextNames of the Document Chunks on which this processor should be applied. If this list is empty, all DocumentChunks are processed. |
| dataModelState | string | - | Is this semantic processor managed by a data model? @enum{null,auto,customized, error}. If null, this semantic processor is not related to the data model. If "auto", this semantic processor is auto-generated by the data model. |
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disables the DocumentProcessor |
| resourceFile | string | - | URL for the resource (data://, file:// or resource://) |
| Type | Wrapper | Description |
| SemanticProcessor | fromDataModel | If dataModelState is "customized", you will find here the original semantic processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| Name | Type | Default value | Description |
| name | string | - | Name of the Semantic Processor. This name is only used for tracing and debugging purposes. |
| contexts | string | - | Comma-separated list of the ContextNames of the Document Chunks on which this processor should be applied. If this list is empty, all DocumentChunks are processed. |
| dataModelState | string | - | Is this semantic processor managed by a data model? @enum{null,auto,customized, error}. If null, this semantic processor is not related to the data model. If "auto", this semantic processor is auto-generated by the data model. |
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disables the DocumentProcessor |
| resourceFile | string | - | URL for the resource (data://, file:// or resource://) |
| Type | Wrapper | Description |
| SemanticProcessor | fromDataModel | If dataModelState is "customized", you will find here the original semantic processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| Name | Type | Default value | Description |
| name | string | - | Name of the Semantic Processor. This name is only used for tracing and debugging purposes. |
| contexts | string | - | Comma-separated list of the ContextNames of the Document Chunks on which this processor should be applied. If this list is empty, all DocumentChunks are processed. |
| dataModelState | string | - | Is this semantic processor managed by a data model? @enum{null,auto,customized, error}. If null, this semantic processor is not related to the data model. If "auto", this semantic processor is auto-generated by the data model. |
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disables the DocumentProcessor |
| classId | string | - | The specified class must implement the {@code com.exalead.indexing.analysis.semantic.CustomSemanticProcessorInterface} Exascript interface. |
| Type | Wrapper | Description |
| SemanticProcessor | fromDataModel | If dataModelState is "customized", you will find here the original semantic processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| KeyValue* | - |
| Name | Type | Default value | Description |
| name | string | - | Name of this processor. The name of a processor is used only for tracing and debugging purposes. |
| dataModelState | string | - | Is this document processor managed by a data model? @enum{null,auto,customized, error}.
|
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disable the DocumentProcessor |
| formattingString | string | - | This string contains variables in one of the 3 following formats: 1. $(name), the name of a context: output is the textual content of this context. 2. $/name:regexp/, the name of a context whose chunks must match the regexp: output is the piece of text that has matched. 3. $/name:regexp:format/, the name of a context whose chunks must match the regexp: output is defined by a sed-like format referencing the regexp subexpressions. Warning: Colons and slashes must be escaped with a backslash. For example : "$(firstname) $(lastname) : $/age:[0-9]+/ $/date:([0-9]{2})([0-9]{2})([0-9]{4}):day=\\1 month=\\2 year=\\3" |
| outputContext | string | - | ContextName to be associated with the DocumentChunk created for each generated value. |
| strict | boolean | True | Forces all the manipulated contexts found to process. |
| Type | Wrapper | Description |
| DocumentProcessor | fromDataModel | If dataModelState is "customized", you will find here the
original document processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| AcceptCondition | - | Expresses the enablement condition of this DocumentProcessor. |
| Name | Type | Default value | Description |
| name | string | - | Name of this processor. The name of a processor is used only for tracing and debugging purposes. |
| dataModelState | string | - | Is this document processor managed by a data model? @enum{null,auto,customized, error}.
|
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disable the DocumentProcessor |
| outputContext | string | - | The new ContextName for DocumentChunks with an unmapped ContextName. |
| Type | Wrapper | Description |
| DocumentProcessor | fromDataModel | If dataModelState is "customized", you will find here the
original document processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| AcceptCondition | - | Expresses the enablement condition of this DocumentProcessor. |
| Name | Type | Default value | Description |
| name | string | - | Name of this processor. The name of a processor is used only for tracing and debugging purposes. |
| dataModelState | string | - | Is this document processor managed by a data model? @enum{null,auto,customized, error}.
|
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disable the DocumentProcessor |
| outputContext | string | - | The ContextName used for newly created chunks. |
| value | string | - | The value used for newly created chunks. |
| partName | string | - | The part to which the chunk should belong. If nothing is specified here, the chunk will be handled as a global chunk. |
| language | iso code | - | Language of the chunk, as an ISO639 code. |
| Type | Wrapper | Description |
| DocumentProcessor | fromDataModel | If dataModelState is "customized", you will find here the
original document processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| AcceptCondition | - | Expresses the enablement condition of this DocumentProcessor. |
| Name | Type | Default value | Description |
| name | string | - | Name of this processor. The name of a processor is used only for tracing and debugging purposes. |
| dataModelState | string | - | Is this document processor managed by a data model? @enum{null,auto,customized, error}.
|
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disable the DocumentProcessor |
| outputContext | string | - | The ContextName used for newly created chunks. |
| modulo | int | - | Inverse probability of adding the new chunk. Must be a strictly positive integer. |
| Type | Wrapper | Description |
| DocumentProcessor | fromDataModel | If dataModelState is "customized", you will find here the
original document processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| StringValue* | values | List of possible values. |
| AcceptCondition | - | Expresses the enablement condition of this DocumentProcessor. |
| Name | Type | Default value | Description |
| outputContext | string | - | The ContextName used for newly created chunks. |
| modulo | int | - | Inverse probability of adding the new chunk. Must be a strictly positive integer. |
| name | string | - | Name of this processor. The name of a processor is used only for tracing and debugging purposes. |
| dataModelState | string | - | Is this document processor managed by a data model? @enum{null,auto,customized, error}.
|
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disable the DocumentProcessor |
| parameter | double | - | The exponent characterizing the distribution. |
| Type | Wrapper | Description |
| StringValue* | values | List of possible values. |
| DocumentProcessor | fromDataModel | If dataModelState is "customized", you will find here the
original document processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| AcceptCondition | - | Expresses the enablement condition of this DocumentProcessor. |
| Name | Type | Default value | Description |
| name | string | - | Name of this processor. The name of a processor is used only for tracing and debugging purposes. |
| dataModelState | string | - | Is this document processor managed by a data model? @enum{null,auto,customized, error}.
|
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disable the DocumentProcessor |
| relevantChunkContext | string | relevantcontent | Relevant text chunks will be copied in this context. |
| newContextName | string | relevantcontent | Deprecated, use 'relevantChunkContext'. |
| irrelevantChunkContext | string | excludedcontent | Irrelevant text chunks will be copied in this context. |
| retrieveFieldContext | string | htmlcontent | Original text chunks will be moved in this context. |
| irrelevantChunkAnnotation | string | - | If set, the HTMLRelevantContentExtractor will annotate each irrelevant chunk with an annotation. |
| minScore | int | 15 | Internally, the HTMLRelevantContentExtractor assigns a score to each chunk of its input. Use 'minScore' to keep only chunks having a score greater than a value. |
| minParagraphWords | int | 7 | The minimum number of words a <p> chunk must have to be considered as a paragraph and be boosted. |
| minTitleWords | int | 3 | The minimum number of words a title must have to be boosted. |
| linkAllowedInTitle | boolean | True | By default, the links contained in a page title produce a malus, this can be disabled. |
| paragraphBoost | int | 10 | Each time a paragraph will be detected, the score will be increased by this value. |
| maxWordInLinkRatio | int | 2 | The maximum allowed ratio of words contained in links in a chunk of text. |
| titleBoost | int | 5 | Each time a title will be detected, the score will be increased by this value. |
| classBoost | int | 10 | Each time a CSS class included in 'idsAndClassesToKeep' will be detected, the score will be increased by this value. |
| keepOnlyBestChunk | boolean | False | If true, the 'relevantcontent' will only be composed by the main article of the page. |
| skipBlockquotes | boolean | False | Ability to skip HTML blockquote tags. |
| skipPre | boolean | False | Ability to skip HTML pre tags. |
| keepImages | boolean | False | If true, the HTML image annotations will be kept in the new context. |
| Type | Wrapper | Description |
| DocumentProcessor | fromDataModel | If dataModelState is "customized", you will find here the
original document processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| StringValue* | idsAndClassesToIgnore | The list of CSS classes and HTML ids to ignore. |
| StringValue* | idsAndClassesToKeep | The list of CSS classes and HTML ids to boost. |
| StringValue* | annotationsToCopy | The list of annotations to keep in the new context. |
| AcceptCondition | - | Expresses the enablement condition of this DocumentProcessor. |
| Name | Type | Default value | Description |
| name | string | - | Name of this processor. The name of a processor is used only for tracing and debugging purposes. |
| dataModelState | string | - | Is this document processor managed by a data model? @enum{null,auto,customized, error}.
|
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disable the DocumentProcessor |
| newContextName | string | webtable | The ContextName used for newly created chunks. |
| minColumnsRequired | int | 2 | The minimum number of columns required to extract. |
| maxColumnsRequired | int | 2147483647 | The maximum number of columns required to extract. |
| concatenateRows | boolean | False | Concatenates all rows. |
| Type | Wrapper | Description |
| DocumentProcessor | fromDataModel | If dataModelState is "customized", you will find here the
original document processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| AcceptCondition | - | Expresses the enablement condition of this DocumentProcessor. |
document.setProcessingFlag(Operation.DISCARD_AND_DELETE);
((AnalysisDocumentProcessingContext) context).stopProcessingAfterCurrentProcessor();
@desc Discards documents from the pipeline.
| Name | Type | Default value | Description |
| name | string | - | Name of this processor. The name of a processor is used only for tracing and debugging purposes. |
| dataModelState | string | - | Is this document processor managed by a data model? @enum{null,auto,customized, error}.
|
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disable the DocumentProcessor |
| logDiscardedDocuments | boolean | False | If true, the URI of each discarded documents is logged on each analysis process log file. |
| Type | Wrapper | Description |
| DocumentProcessor | fromDataModel | If dataModelState is "customized", you will find here the
original document processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| AcceptCondition | - | Expresses the enablement condition of this DocumentProcessor. |
| Name | Type | Default value | Description |
| name | string | - | Name of this processor. The name of a processor is used only for tracing and debugging purposes. |
| dataModelState | string | - | Is this document processor managed by a data model? @enum{null,auto,customized, error}.
|
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disable the DocumentProcessor |
| inputSubstring | string | - | The piece of string to be replaced. |
| outputReplacement | string | - | The replacement string. |
| Type | Wrapper | Description |
| DocumentProcessor | fromDataModel | If dataModelState is "customized", you will find here the
original document processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| AcceptCondition | - | Expresses the enablement condition of this DocumentProcessor. |
| Name | Type | Default value | Description |
| name | string | - | Name of this processor. The name of a processor is used only for tracing and debugging purposes. |
| dataModelState | string | - | Is this document processor managed by a data model? @enum{null,auto,customized, error}.
|
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disable the DocumentProcessor |
| Type | Wrapper | Description |
| DocumentProcessor | fromDataModel | If dataModelState is "customized", you will find here the
original document processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| StringValue* | classes | |
| StringValue* | ids | |
| AcceptCondition | - | Expresses the enablement condition of this DocumentProcessor. |
| Name | Type | Default value | Description |
| name | string | - | Name of this processor. The name of a processor is used only for tracing and debugging purposes. |
| dataModelState | string | - | Is this document processor managed by a data model? @enum{null,auto,customized, error}.
|
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disable the DocumentProcessor |
| outputContext | string | - | ContextName to be associated with the DocumentChunk created for each new context. |
| Type | Wrapper | Description |
| DocumentProcessor | fromDataModel | If dataModelState is "customized", you will find here the
original document processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| StringValue* | classes | List of classes used to determine whether a chunk must be duplicated. |
| StringValue* | ids | List of ids used to determine whether a chunk must be duplicated. |
| AcceptCondition | - | Expresses the enablement condition of this DocumentProcessor. |
| Name | Type | Default value | Description |
| name | string | - | Name of this processor. The name of a processor is used only for tracing and debugging purposes. |
| dataModelState | string | - | Is this document processor managed by a data model? @enum{null,auto,customized, error}.
|
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disable the DocumentProcessor |
| Type | Wrapper | Description |
| DocumentProcessor | fromDataModel | If dataModelState is "customized", you will find here the
original document processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| AcceptCondition | - | Expresses the enablement condition of this DocumentProcessor. |
| Name | Type | Default value | Description |
| name | string | - | Name of this processor. The name of a processor is used only for tracing and debugging purposes. |
| dataModelState | string | - | Is this document processor managed by a data model? @enum{null,auto,customized, error}.
|
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disable the DocumentProcessor |
| Type | Wrapper | Description |
| DocumentProcessor | fromDataModel | If dataModelState is "customized", you will find here the
original document processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| AcceptCondition | - | Expresses the enablement condition of this DocumentProcessor. |
| KeyValue* | - |
| Name | Type | Default value | Description |
| name | string | - | Name of this processor. The name of a processor is used only for tracing and debugging purposes. |
| dataModelState | string | - | Is this document processor managed by a data model? @enum{null,auto,customized, error}.
|
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disable the DocumentProcessor |
| classId | string | - | Class identifier. The specified class must implement the com.exalead.pdoc.analysis.CustomDocumentProcessor Java Interface. |
| Type | Wrapper | Description |
| DocumentProcessor | fromDataModel | If dataModelState is "customized", you will find here the
original document processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| AcceptCondition | - | Expresses the enablement condition of this DocumentProcessor. |
| KeyValue* | - |
| Name | Type | Default value | Description |
| name | string | - | Name of this processor. The name of a processor is used only for tracing and debugging purposes. |
| dataModelState | string | - | Is this document processor managed by a data model? @enum{null,auto,customized, error}.
|
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disable the DocumentProcessor |
| Type | Wrapper | Description |
| DocumentProcessor | fromDataModel | If dataModelState is "customized", you will find here the
original document processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| AcceptCondition | - | Expresses the enablement condition of this DocumentProcessor. |
| Name | Type | Default value | Description |
| name | string | - | Name of this processor. The name of a processor is used only for tracing and debugging purposes. |
| dataModelState | string | - | Is this document processor managed by a data model? @enum{null,auto,customized, error}.
|
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disable the DocumentProcessor |
| outputContext | string | - | The ContextName used for newly created chunks. |
| format | string | - | Either "unixts" or a SimpleDateFormat specification |
| Type | Wrapper | Description |
| DocumentProcessor | fromDataModel | If dataModelState is "customized", you will find here the
original document processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| AcceptCondition | - | Expresses the enablement condition of this DocumentProcessor. |
//img[starts-with(@src, "http://")] because this xpath return a set of nodes (<img>) but xpath count(//img) doesn't work because it returns a number.
@csh AC_XPATH_EXTRACTOR_ID
| Name | Type | Default value | Description |
| name | string | - | Name of this processor. The name of a processor is used only for tracing and debugging purposes. |
| dataModelState | string | - | Is this document processor managed by a data model? @enum{null,auto,customized, error}.
|
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disable the DocumentProcessor |
| htmlParserToUse | enum(htmlCleaner, tagSoup) | htmlCleaner | HTML parser to use in priority. |
| Type | Wrapper | Description |
| DocumentProcessor | fromDataModel | If dataModelState is "customized", you will find here the
original document processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| AcceptCondition | - | Expresses the enablement condition of this DocumentProcessor. |
| XpathRule* | - |
| Name | Type | Default value | Description |
| metaName | string | - | |
| xpath | string | - | |
| concatMutiMatch | boolean | True | Concatenates all results in a value when the xpath expression returns several results. Otherwise, it adds each match in a multiValued meta. It should be unselected if you want each node returned by xpath expression in different value (like list of item). |
| Name | Type | Default value | Description |
| name | string | - | Name of this processor. The name of a processor is used only for tracing and debugging purposes. |
| dataModelState | string | - | Is this document processor managed by a data model? @enum{null,auto,customized, error}.
|
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disable the DocumentProcessor |
| inputFragmentMeta | string | - | |
| parserToUse | enum(htmlCleaner, tagSoup, xmlParser) | xmlParser | Parser to use in priority. |
| Type | Wrapper | Description |
| DocumentProcessor | fromDataModel | If dataModelState is "customized", you will find here the
original document processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| AcceptCondition | - | Expresses the enablement condition of this DocumentProcessor. |
| XpathFragmentRule* | - |
| Name | Type | Default value | Description |
| metaName | string | - | |
| xpath | string | - |
| Name | Type | Default value | Description |
| name | string | - | Name of this processor. The name of a processor is used only for tracing and debugging purposes. |
| dataModelState | string | - | Is this document processor managed by a data model? @enum{null,auto,customized, error}.
|
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disable the DocumentProcessor |
| version | int | 1 | Specifies the version. |
| Type | Wrapper | Description |
| DocumentProcessor | fromDataModel | If dataModelState is "customized", you will find here the
original document processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| StringValue* | values | List of the names of the metas to parse and to transform to part. |
| AcceptCondition | - | Expresses the enablement condition of this DocumentProcessor. |
| Name | Type | Default value | Description |
| name | string | - | Name of this processor. The name of a processor is used only for tracing and debugging purposes. |
| dataModelState | string | - | Is this document processor managed by a data model? @enum{null,auto,customized, error}.
|
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disable the DocumentProcessor |
| Type | Wrapper | Description |
| DocumentProcessor | fromDataModel | If dataModelState is "customized", you will find here the
original document processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| AcceptCondition | - | Expresses the enablement condition of this DocumentProcessor. |
| DocumentProcessor* | - |
| Name | Type | Default value | Description |
| name | string | - | Name of this processor. The name of a processor is used only for tracing and debugging purposes. |
| dataModelState | string | - | Is this document processor managed by a data model? @enum{null,auto,customized, error}.
|
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disable the DocumentProcessor |
| indexField | string | - | The index field in which the value will be stored. |
| indexFieldUnitSymbol | string | - | The output unit symbol |
| suffixName | string | _um | Output suffix to create a new meta as output |
| removeContext | boolean | False | Remove contexts after processing |
| Type | Wrapper | Description |
| DocumentProcessor | fromDataModel | If dataModelState is "customized", you will find here the
original document processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| AcceptCondition | - | Expresses the enablement condition of this DocumentProcessor. |
| Name | Type | Default value | Description |
| name | string | - | Name of this processor. The name of a processor is used only for tracing and debugging purposes. |
| dataModelState | string | - | Is this document processor managed by a data model? @enum{null,auto,customized, error}.
|
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disable the DocumentProcessor |
| type | string | exception | The crash type {@code enum(noop,exception,oom,infiniteloop,nullptr,abort,assert,segv,intdiv)} |
| delay | int | 0 | Trigger delay in seconds. |
| count | int | 3 | Trigger document count. |
| Type | Wrapper | Description |
| DocumentProcessor | fromDataModel | If dataModelState is "customized", you will find here the
original document processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| AcceptCondition | - | Expresses the enablement condition of this DocumentProcessor. |
| Name | Type | Default value | Description |
| name | string | - | Name of this processor. The name of a processor is used only for tracing and debugging purposes. |
| dataModelState | string | - | Is this document processor managed by a data model? @enum{null,auto,customized, error}.
|
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disable the DocumentProcessor |
| metaMatrix | string | matrix | Name of the meta containing the matrix data. |
| fieldMatrix | string | matrix | Name of the target matrix field. |
| fieldInvMatrix | string | invmatrix | Name of the target matrix field. |
| metaCGR | string | cgr | Name of the meta containing the CGRs. |
| fieldOctree | string | octree | Name of target octree field. |
| Type | Wrapper | Description |
| DocumentProcessor | fromDataModel | If dataModelState is "customized", you will find here the
original document processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| AcceptCondition | - | Expresses the enablement condition of this DocumentProcessor. |
| Name | Type | Default value | Description |
| name | string | - | Name of this processor. The name of a processor is used only for tracing and debugging purposes. |
| dataModelState | string | - | Is this document processor managed by a data model? @enum{null,auto,customized, error}.
|
| dataModelClass | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor. |
| dataModelProperty | string | - | If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor. |
| disabled | boolean | False | Disable the DocumentProcessor |
| partCGR | string | CGR | Name of the part containing the CGR data (tesselation). |
| partOctree | string | octree | Name of the part used to store the resulting octree. |
| docIdentifyer | string | majorid | Name of the meta identifying the document. |
| Type | Wrapper | Description |
| DocumentProcessor | fromDataModel | If dataModelState is "customized", you will find here the
original document processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor |
| AcceptCondition | - | Expresses the enablement condition of this DocumentProcessor. |
| Name | Type | Default value | Description |
| wordMaxLength | int | 100 | Maximal length of a word. 100 is the default value. |
| hexCharMax | int | 0 | Maximal number of hexadecimal characters that can appear in a word. This filter applies only for words bigger than 'hexLengthMin'. 0 = no filter (default value) |
| hexLengthMin | int | 0 | Minimal number of characters in a word for the hexadecimal filter to apply. 0 = no filter (default value) |
| maxNumChars | int | 0 | Maximal number of characters in a word. 0 = no filter (default value) |
| Name | Type | Default value | Description |
| language | iso code | - | The language iso code |
| generateWordDict | boolean | False | Extracts words for the global dictionary. |
| wordDictModulo | int | 1 | Word extraction modulo, by default extract all words. |
| maxWordDictWordsPerDocument | long | -1 | Maximum number of words extracted per document. |
| maxExtractedWordLength | int | 64 | Maximum length a word must have to be extracted. |
| spellCheckNGramMaxSize | int | 3 | Maximum number of consecutive words for spellchecking. If the value is set to '-1', spellcheck data is not generated for this language. 0 and 1 values are illegal, default is 3. |
| spellCheckNGramsDictModulo | int | 5 | NGrams extraction modulo. It extracts 1 ngram out of 5 by default. |
| maxSpellCheckNGramsPerDocument | long | -1 | Maximum number of ngrams extracted per document. |
| maxExtractedSpellCheckNGramLength | int | 256 | Maximum length an ngram must have to be extracted. |
| relatedTermsDictModulo | int | 1 | Submits 1 out of X documents for related terms generation. If the value is set to 0, related terms are not generated for this language. |
| maxRelatedTermsDictContextsPerDocument | long | -1 | Maximum number of related terms extracted per document. |
| Type | Wrapper | Description |
| AnnotationMapping* | - | List of mappings from annotations to index targets, with associated parameters. |
| ContextMapping* | - | List mappings from contexts to index targets, with associated parameters. |
| FieldIndexingLimit* | - | Word count limits to apply to texts mapped to index fields for search. |
| FieldRetrievalLimit* | - | Size limits (in bytes) to apply to texts mapped to the index for retrieval. |
| GenerateAnnotationsForContext* | - | List of contexts to process with a semantic pipeline before mapping. |
| PartMapping* | - | List mappings from parts to index targets, with associated parameters. |
| WordCountMapping* | - | Specify where to map Word count. |
| Name | Type | Default value | Description |
| name | string | - | Name of the SemanticAnnotation to map. |
| context | string | - | Optional input context restricting the mapping from the annotations coming from a specific context. Incompatible with the patternMatch feature. |
| patternMatch | boolean | False | Matches all annotations matching this pattern (must be a valid regular expression). |
| dataModelState | string | - | Is this annotation target managed by a data model?
@enum{null,auto,customized}. If null, this annotation mapping is not related to a data model. If "auto", this annotation mapping is auto-generated by a data model If "customized", this annotation mapping was auto-generated by a data model and then customized. |
| dataModelClass | string | - | If dataModelState is "auto" or "customized", you will find here the name of the DataModelClass that generated this annotation mapping. |
| dataModelProperty | string | - | If dataModelState is "auto" or "customized", you will find here the name of the DataModelProperty that generated this annotation mapping. |
| Type | Wrapper | Description |
| AnnotationMapping | fromDataModel | If dataModelState is "customized", you will find here the
original annotation mapping generated by the data model. Use this to easily show what reverting to "auto" from "customized" would imply |
| AnnotationTarget* | - |
| Name | Type | Default value | Description |
| indexField | string | - | |
| forcedRank | long | - | |
| rankBoost | long | 0 | |
| form | string | normalized | Which form of SemanticAnnotation value should we index? {@code enum(exact,normalized)} |
| dataModelState | string | - | Is this annotation target managed by a data model? @enum{null,auto,customized}. If null, this prefix handler is not related to a data model. If "auto", this prefix handler is auto-generated by a data model. If "customized", this prefix handler was auto-generated by a data model and then customized. |
| dataModelClass | string | - | If dataModelState is "auto" or "customized", you will find here the name of the DataModelClass that generated this AnnotationTarget. |
| dataModelProperty | string | - | If dataModelState is "auto" or "customized", you will find here the name of the DataModelProperty that generated this AnnotationTarget. |
| categoryRoot | string | - | Prefix used to build the CategoryPath. |
| categoryAppend | boolean | True | Builds the category path by concatenating the categoryRoot and the selected 'form' of the annotation. If false, only the category root will be used. |
| appendAnnotationNameToRoot | boolean | False | Appends the annotation name between the root and the value. |
| retrievable | boolean | False | If true, the category path is retrievable and can be used to create facets. If false, the category path is only searchable. (Advanced usage. langdate hacks) |
| cleanupContent | boolean | True | Removes trailing and leading spaces. Removes category path without AlphaNum character. |
| detectTitle | boolean | False | Detect words set after # in path and use them as title |
| Type | Wrapper | Description |
| AnnotationTarget | fromDataModel | If dataModelState is "customized", you will find here the original prefix handler generated by the data model. Use this to easily see what reverting to "auto" from "customized" would imply. |
| Name | Type | Default value | Description |
| indexField | string | - | |
| forcedRank | long | - | |
| rankBoost | long | 0 | |
| form | string | normalized | Which form of SemanticAnnotation value should we index? {@code enum(exact,normalized)} |
| dataModelState | string | - | Is this annotation target managed by a data model? @enum{null,auto,customized}. If null, this prefix handler is not related to a data model. If "auto", this prefix handler is auto-generated by a data model. If "customized", this prefix handler was auto-generated by a data model and then customized. |
| dataModelClass | string | - | If dataModelState is "auto" or "customized", you will find here the name of the DataModelClass that generated this AnnotationTarget. |
| dataModelProperty | string | - | If dataModelState is "auto" or "customized", you will find here the name of the DataModelProperty that generated this AnnotationTarget. |
| searchable | boolean | False | If true, the SemanticAnnotation can be searched for. |
| indexLevel | string | - | If searchable, index kind where data will be indexed. Can be "exact", "lowercase", "normalized" or "custom". |
| customIndexKind | int | - | If indexLevel = "custom", this index kind will be used. |
| retrievable | boolean | False | If true, the SemanticAnnotation can be retrieved. |
| retrieveField | string | - | The field where the SemanticAnnotation is stored for retrieval, if 'retrievable' is set to true. If null, 'indexField' will be used to store the SemanticAnnotation for retrieval. |
| Type | Wrapper | Description |
| AnnotationTarget | fromDataModel | If dataModelState is "customized", you will find here the original prefix handler generated by the data model. Use this to easily see what reverting to "auto" from "customized" would imply. |
| Name | Type | Default value | Description |
| indexField | string | - | |
| forcedRank | long | - | |
| rankBoost | long | 0 | |
| form | string | normalized | Which form of SemanticAnnotation value should we index? {@code enum(exact,normalized)} |
| dataModelState | string | - | Is this annotation target managed by a data model? @enum{null,auto,customized}. If null, this prefix handler is not related to a data model. If "auto", this prefix handler is auto-generated by a data model. If "customized", this prefix handler was auto-generated by a data model and then customized. |
| dataModelClass | string | - | If dataModelState is "auto" or "customized", you will find here the name of the DataModelClass that generated this AnnotationTarget. |
| dataModelProperty | string | - | If dataModelState is "auto" or "customized", you will find here the name of the DataModelProperty that generated this AnnotationTarget. |
| enumFacetId | string | - | The id of the EnumFacetAnnotationTarget this target refers to. |
| Type | Wrapper | Description |
| AnnotationTarget | fromDataModel | If dataModelState is "customized", you will find here the original prefix handler generated by the data model. Use this to easily see what reverting to "auto" from "customized" would imply. |
| Name | Type | Default value | Description |
| name | string | - | ContextName of the DocumentChunks to map. |
| prefixMatch | boolean | False | Matches all context that starts with this prefix. |
| unprefix | boolean | False | Remove the prefix that was used to match. |
| patternMatch | boolean | False | Matches all context matching this pattern (must be a valid regular expression). |
| semantic | boolean | True | Performs semantic processing on the DocumentChunks processed by this mapping. If false, the textual content of the DocumentChunks will not be tokenized before indexing. This can be used to index 'exact raw values'. |
| resourceFreq | int | 1 | To extract a resource, select the frequency to add. For example, if you have a 'firstname lastname' entry, you may want to simulate a frequency of 1000 to avoid spellcheck on this entry. |
| tokenizationConfig | string | - | |
| dataModelState | string | - | Is this content target managed by a data model?
@enum{null,auto,customized}. If null, this context mapping is not related to a data model. If "auto", this context mapping is auto-generated by a data model If "customized", this context mapping was auto-generated by a data model and then customized. |
| dataModelClass | string | - | If dataModelState is "auto" or "customized", you will find here the name of the DataModelClass that generated this context mapping. |
| dataModelProperty | string | - | If dataModelState is "auto" or "customized", you will find here the name of the DataModelProperty that generated this ContextMapping |
| Type | Wrapper | Description |
| ContextMapping | fromDataModel | If dataModelState is "customized", you will find here the
original context mapping generated by the data model. Use this to easily show what reverting to "auto" from "customized" would imply. |
| Target* | - |
| Name | Type | Default value | Description |
| indexField | string | - | The indexField to populate with this content. If null, the contextName of the DocumentChunk will be used for the index field. |
| forcedRank | long | - | Sets the ranking value for chunks in this mapping. -1 means that the chunk internal ranking value is kept. |
| rankBoost | long | 0 | Offsets the chunk internal ranking value. Use it only when forcedRank = -1 For example, if forcedRank=-1, rankBoost=2, and the chunk internal ranking value is 4, the final rank will be 6. |
| categoryRoot | string | - | Builds the category path. |
| categoryAppend | boolean | True | Appends the textual content of the DocumentChunk to the category root. If false, only the category root will be used. |
| appendContextNameToRoot | boolean | False | Appends the context name between the root and the value. |
| form | string | normalized | The form of the word to be used to build the category path. {@code enum(exact,normalized)} |
| retrievable | boolean | False | Stores the category path, which enables display and navigation by category path. If false, we only index the SemanticAnnotation (Advanced usage - langdate hacks). |
| cleanupContent | boolean | True | If true:
|
| detectTitle | boolean | False | Detect words set after # in path and use them as title |
| Name | Type | Default value | Description |
| categoryRoot | string | - | Builds the category path. |
| categoryAppend | boolean | True | Appends the textual content of the DocumentChunk to the category root. If false, only the category root will be used. |
| appendContextNameToRoot | boolean | False | Appends the context name between the root and the value. |
| form | string | normalized | The form of the word to be used to build the category path. {@code enum(exact,normalized)} |
| retrievable | boolean | False | Stores the category path, which enables display and navigation by category path. If false, we only index the SemanticAnnotation (Advanced usage - langdate hacks). |
| cleanupContent | boolean | True | If true:
|
| detectTitle | boolean | False | Detect words set after # in path and use them as title |
| indexField | string | - | The indexField to populate with this content. If null, the contextName of the DocumentChunk will be used for the index field. |
| forcedRank | long | - | Sets the ranking value for chunks in this mapping. -1 means that the chunk internal ranking value is kept. |
| rankBoost | long | 0 | Offsets the chunk internal ranking value. Use it only when forcedRank = -1 For example, if forcedRank=-1, rankBoost=2, and the chunk internal ranking value is 4, the final rank will be 6. |
| inputFormat | string | - | Specifies the input format of the date, in UNIX date format. Set null value for automatic detection of standard formats. |
| Name | Type | Default value | Description |
| indexField | string | - | The indexField to populate with this content. If null, the contextName of the DocumentChunk will be used for the index field. |
| forcedRank | long | - | Sets the ranking value for chunks in this mapping. -1 means that the chunk internal ranking value is kept. |
| rankBoost | long | 0 | Offsets the chunk internal ranking value. Use it only when forcedRank = -1 For example, if forcedRank=-1, rankBoost=2, and the chunk internal ranking value is 4, the final rank will be 6. |
| prefixWithContext | boolean | False | Enables prefixing of all words in inverted lists by 'contextName#'. |
| addStartEnd | boolean | False | Enables the introduction of a word __start__ before chunk content and a word __end__ after chunk content. Only valid if Chunk is mapped with semantic=true. This option is compatible with prefixContextName: produce contextName#__start__ and contextName#__end__) |
| indexPrefixes | boolean | False | Enables the indexing of all prefixes for each word with a score = prefixScore. The prefix can be mapped to a specific type if you add 'prefix' in formIndexingConfig. |
| prefixesScore | int | 1 | Score given to words' prefixes. The document relevance is determined by its score. The text matching score basically represents the "distance" between a search query and a document. |
| maxPrefixLength | int | 0 | Maximum length of the extracted prefixes. |
| indexSuffixes | boolean | False | Enables the indexing of all suffixes for each word with a score = suffixScore. The suffix can be mapped to a specific kind if you add 'suffix' in formIndexingConfig. |
| suffixesScore | int | 1 | Score given to words' prefixes. The document relevance is determined by its score. The text matching score basically represents the "distance" between a search query and a document. |
| maxSuffixLength | int | 0 | Maximum length of the extracted suffixes. |
| indexSubstrings | boolean | False | Enables the indexing of all substrings for each word with a score = substringScore. The suffix can be mapped to a specific kind if you add 'substring' in formIndexingConfig. |
| substringsScore | int | 1 | Score given to extracted substrings. Document relevance is determined by its score. The text matching score basically represents the "distance" between a search query and a document. |
| searchable | boolean | True | Marks the content of the DocumentChunk as indexed and searchable. |
| retrievable | boolean | True | Enables the content of the DocumentChunk to be directly stored in the index, so that it can be retrieved. For numerical values, retrievability allows you to sort results by field. |
| retrieveField | string | - | The index field in which the content will be stored. If null, the content will be put in 'indexField'. |
| indexNormalized | boolean | True | Enables the indexing of the normalized form of the word. |
| indexLowercase | boolean | False | Enables the indexing of the lowercase (non-normalized) form of each token. |
| indexExact | boolean | False | Enables the indexing of the exact (non-normalized) form of each token. |
| indexSeparators | boolean | False | Enables the indexing of the index standard separators. Indexed standard separators are: paragraph, sentence and page. Standard separators indexing is required for the SPLIT operator to work with these separators. |
| addBreakBetweenChunks | boolean | True | Enables the introduction of a break between document chunks by the indexer. This forbids phrase matching across these chunks and has an impact on search when using double-quotes expressions or the 'NEXT' operator. For example, if a document has a "title" chunk containing "foo" and a "text" chunk containing "bar", and they are both remapped to the text field.
|
| Type | Wrapper | Description |
| DecreaseRankOnAnnotation* | - | List of DecreaseRankOnAnnotation |
| IncreaseRankOnAnnotation* | - | List of IncreaseRankOnAnnotation |
| RankOnAnnotation* | - | List of RankOnAnnotation |
| Name | Type | Default value | Description |
| prefixWithContext | boolean | False | Enables prefixing of all words in inverted lists by 'contextName#'. |
| addStartEnd | boolean | False | Enables the introduction of a word __start__ before chunk content and a word __end__ after chunk content. Only valid if Chunk is mapped with semantic=true. This option is compatible with prefixContextName: produce contextName#__start__ and contextName#__end__) |
| indexPrefixes | boolean | False | Enables the indexing of all prefixes for each word with a score = prefixScore. The prefix can be mapped to a specific type if you add 'prefix' in formIndexingConfig. |
| prefixesScore | int | 1 | Score given to words' prefixes. The document relevance is determined by its score. The text matching score basically represents the "distance" between a search query and a document. |
| maxPrefixLength | int | 0 | Maximum length of the extracted prefixes. |
| indexSuffixes | boolean | False | Enables the indexing of all suffixes for each word with a score = suffixScore. The suffix can be mapped to a specific kind if you add 'suffix' in formIndexingConfig. |
| suffixesScore | int | 1 | Score given to words' prefixes. The document relevance is determined by its score. The text matching score basically represents the "distance" between a search query and a document. |
| maxSuffixLength | int | 0 | Maximum length of the extracted suffixes. |
| indexSubstrings | boolean | False | Enables the indexing of all substrings for each word with a score = substringScore. The suffix can be mapped to a specific kind if you add 'substring' in formIndexingConfig. |
| substringsScore | int | 1 | Score given to extracted substrings. Document relevance is determined by its score. The text matching score basically represents the "distance" between a search query and a document. |
| searchable | boolean | True | Marks the content of the DocumentChunk as indexed and searchable. |
| retrievable | boolean | True | Enables the content of the DocumentChunk to be directly stored in the index, so that it can be retrieved. For numerical values, retrievability allows you to sort results by field. |
| retrieveField | string | - | The index field in which the content will be stored. If null, the content will be put in 'indexField'. |
| indexNormalized | boolean | True | Enables the indexing of the normalized form of the word. |
| indexLowercase | boolean | False | Enables the indexing of the lowercase (non-normalized) form of each token. |
| indexExact | boolean | False | Enables the indexing of the exact (non-normalized) form of each token. |
| indexSeparators | boolean | False | Enables the indexing of the index standard separators. Indexed standard separators are: paragraph, sentence and page. Standard separators indexing is required for the SPLIT operator to work with these separators. |
| addBreakBetweenChunks | boolean | True | Enables the introduction of a break between document chunks by the indexer. This forbids phrase matching across these chunks and has an impact on search when using double-quotes expressions or the 'NEXT' operator. For example, if a document has a "title" chunk containing "foo" and a "text" chunk containing "bar", and they are both remapped to the text field.
|
| indexField | string | - | The indexField to populate with this content. If null, the contextName of the DocumentChunk will be used for the index field. |
| forcedRank | long | - | Sets the ranking value for chunks in this mapping. -1 means that the chunk internal ranking value is kept. |
| rankBoost | long | 0 | Offsets the chunk internal ranking value. Use it only when forcedRank = -1 For example, if forcedRank=-1, rankBoost=2, and the chunk internal ranking value is 4, the final rank will be 6. |
| inputFormat | string | - | Specifies the input format of the date, in UNIX date format. Set null value for automatic detection of standard formats. |
| Type | Wrapper | Description |
| DecreaseRankOnAnnotation* | - | List of DecreaseRankOnAnnotation |
| IncreaseRankOnAnnotation* | - | List of IncreaseRankOnAnnotation |
| RankOnAnnotation* | - | List of RankOnAnnotation |
| Name | Type | Default value | Description |
| annotationName | string | - | Name of the targeted annotation. |
| annotationValue | string | - | Value of the annotation that will trigger the decrease in ranking. |
| value | int | - | Number to decrease from the ranking when triggered. |
| Name | Type | Default value | Description |
| annotationName | string | - | Name of the targeted annotation. |
| annotationValue | string | - | Value of the annotation that will trigger the increase in ranking. |
| value | int | - | Number to increase in the ranking when triggered. |
| Name | Type | Default value | Description |
| annotationName | string | - | The annotation that triggers the ranking modification. |
| annotationValue | string | - | The annotation value required to trigger the ranking modification. |
| forcedRank | int | - | The new ranking. |
| Name | Type | Default value | Description |
| indexField | string | - | The indexField to populate with this content. If null, the contextName of the DocumentChunk will be used for the index field. |
| forcedRank | long | - | Sets the ranking value for chunks in this mapping. -1 means that the chunk internal ranking value is kept. |
| rankBoost | long | 0 | Offsets the chunk internal ranking value. Use it only when forcedRank = -1 For example, if forcedRank=-1, rankBoost=2, and the chunk internal ranking value is 4, the final rank will be 6. |
| searchable | boolean | True | If true, the content of the DocumentChunk will be indexed and searchable. |
| retrieveField | string | - | The index field in which the content will be stored. If null, the content will be put in 'indexField'. |
| retrievable | boolean | True | Stores the content of the DocumentChunk directly in the index, so that it can be retrieved. For numerical values, retrievability enables to sort results by field. |
| indexKind | int | - | Index 'Kind' to use for indexing content. |
| addBreakBetweenChunks | boolean | True | If true, the indexer introduces a break between document chunks. This forbids phrase matching across these chunks and has an impact on search when using double-quotes expressions or the 'NEXT' operator. For example, if a document has a "title" chunk containing "foo" and a "text" chunk containing "bar", and they are both remapped to the text field:
|
| Name | Type | Default value | Description |
| indexField | string | - | The indexField to populate with this content. If null, the contextName of the DocumentChunk will be used for the index field. |
| forcedRank | long | - | Sets the ranking value for chunks in this mapping. -1 means that the chunk internal ranking value is kept. |
| rankBoost | long | 0 | Offsets the chunk internal ranking value. Use it only when forcedRank = -1 For example, if forcedRank=-1, rankBoost=2, and the chunk internal ranking value is 4, the final rank will be 6. |
| enumFacetId | string | - | The id of the EnumFacet this target refers to. |
| form | string | normalized | The form of the values for the facet stringValues {@code enum(exact,normalized)} |
| Name | Type | Default value | Description |
| dictionaryName | string | - | |
| words | boolean | True | |
| ngrams | boolean | False | |
| rt | boolean | False | |
| phonemes | boolean | False |
| Name | Type | Default value | Description |
| indexField | string | - | The index field in which the content will be stored. |
| Name | Type | Default value | Description |
| fieldName | string | - | Field to limit. |
| maxNbWords | int | - | Maximum number of words for this field. |
| Name | Type | Default value | Description |
| retrieveField | string | - | Field to limit. |
| maxLength | int | - | Max text size in bytes. The text will be clipped to the nearest word. Text is stored in UTF-8. |
| Name | Type | Default value | Description |
| name | string | - | ContextName of the DocumentChunks to map. |
| prefixMatch | boolean | False | Matches any context starting with this prefix. |
| patternMatch | boolean | False | Matches any context matching this regular expression. |
| tokenizationConfig | string | - | If set, it forces the tokenization configuration to use. |
| Name | Type | Default value | Description |
| name | string | - | Name of the Part to map. |
| prefixMatch | boolean | False | Matches all parts that starts with this prefix. |
| patternMatch | boolean | False | Matches all parts matching this pattern (must be a valid regular expression). |
| Type | Wrapper | Description |
| PartTarget* | - |
| Name | Type | Default value | Description |
| fromName | string | - | Compute the word count of this field. |
| toName | string | - | Store the word count to this field. |
| Name | Type | Default value | Description |
| name | string | - | |
| allowIntensiveDiskAccess | boolean | False | Allows intensive operations like sorting or faceting to be performed on disk (SSD should be preferred). |
| Type | Wrapper | Description |
| AttributeGroupStore* | - | |
| FieldConfig* | - |
| Name | Type | Default value | Description |
| id | int | - | A unique identifier for this attribute group. |
| label | string | - | A human readable name for this attribute group. |
| format | enum(SimpleRowOrientedStore, ItemOrientedStore) | ItemOrientedStore | Specifies how to persist the data on disk for this attribute group. |
| retrievableRoles | string | - | Specifies a comma-separated list of annotations to be handled in this attribute group store. Ex: @Facetable,@Sortable,@Display |
| leafSize | int | 30720 | If the format is SimpleRowOrientedStore, configures the leaf size (i.e., maximum IO size read per DID). |
| Name | Type | Default value | Description |
| ramBased | boolean | False | A value field must be RAM-based to perform synthesis efficiently. |
| multiContext | boolean | False | |
| fieldName | string | - | The name of the field. The name of a field can only contain lower-case characters, numbers and underscore. [a-z0-9_]+ |
| searchable | boolean | False | Allows users to query on this field (using a prefix handler). |
| retrievable | boolean | False | Allows the content of this field to be retrieved at query time and displayed in the search results. |
| dataModelState | string | - | Is this index field config managed by a data model?
@enum{null,auto,customized}. If null, this is not related to a data model. If "auto", this is auto-generated by a data model. If "customized", this was auto-generated by a data model and then customized. |
| dataModelClass | string | - | If dataModelState is "auto" or customized", you will find here the name of the DataModelClass that generated this field config. |
| dataModelProperty | string | - | If dataModelState is "auto" or customized", you will find here the name of the DataModelProperty that generated this field config. |
| multivalued | boolean | False | |
| version | int | 0 | |
| maxStoredWordPosition | int | - | Number of words, starting from the beginning of the document, for which
word positions will be stored in the index. This enables proximity ranking and position searching (NEAR, NEXT, ...) up to this number of words in the document. '0' should be used to disable position storing. |
| maxInlineWordPositions | int | 2 | Advanced setting controlling how many positions are inlined in the main data file for each word of each document. |
| useVariablePositionsEncoding | boolean | False | Advanced setting to choose which positions encoding algorithm should be used.
Variable position encoding should be used to reduce index size when indexing big documents. |
| storeTf | boolean | False | Stores the number of terms of each document. This information may be used by the ranking algorithm to normalize term frequencies (as "nbTerms"). This costs a few bytes of RAM per document. |
| bloomFilter | boolean | False | Activates a Bloom filter per slot. This speeds up requests containing words that are not present in the field on a given slot. Disable this option if all words of the request for this field are always matching, and if you compact into big slots regularly. Enable this option if there is either a lot of misses (e.g. on the "text" field) or if you have small updates (e.g. with real-time indexing). |
| gzip | boolean | True | Activates content compression |
| implementation | enum(strbtree, trie, fsm) | fsm | Advanced configuration. Internal structure used to store the field dictionary. |
| nbWordsPerLeaf | int | 1000 | Advanced configuration. If using the strbtree structure, it configures the number of words per leaf. |
| optimizePatternSearch | boolean | True | Adds extra informations to the index for pattern search optimization. If false, optimizes data structures for size. |
| patternSearchOptimizationType | enum(ngramv1, ngramv2) | ngramv1 | Select algorithm based on dictionary ngrams or indexed ngrams (untokenized text only). |
| Type | Wrapper | Description |
| FieldConfig | fromDataModel | If dataModelState is "customized", you will find here the
original object generated by the data model. Use this to easily revert to "auto" state from "customized". |
| ListsEncoderConfig | - | Configuration of the inverted lists encoder. If no configuration is specified, a Rice encoder is used. |
| Name | Type | Default value | Description |
| bytesPerBlock | int | 1024 | |
| positionsRiceCodingParam | int | 1024 | |
| dataFilesPrefetchPages | int | 2 | |
| extFilesPrefetchPages | int | 2 |
| Name | Type | Default value | Description |
| didsPerBlock | int | 256 |
| Name | Type | Default value | Description |
| ramBased | boolean | False | A value field must be RAM-based to perform synthesis efficiently. |
| multiContext | boolean | False | |
| fieldName | string | - | The name of the field. The name of a field can only contain lower-case characters, numbers and underscore. [a-z0-9_]+ |
| searchable | boolean | False | Allows users to query on this field (using a prefix handler). |
| retrievable | boolean | False | Allows the content of this field to be retrieved at query time and displayed in the search results. |
| dataModelState | string | - | Is this index field config managed by a data model?
@enum{null,auto,customized}. If null, this is not related to a data model. If "auto", this is auto-generated by a data model. If "customized", this was auto-generated by a data model and then customized. |
| dataModelClass | string | - | If dataModelState is "auto" or customized", you will find here the name of the DataModelClass that generated this field config. |
| dataModelProperty | string | - | If dataModelState is "auto" or customized", you will find here the name of the DataModelProperty that generated this field config. |
| multivalued | boolean | False | |
| version | int | 0 | |
| bitsForValue | int | 32 | Number of bits used to store numerical values. |
| Type | Wrapper | Description |
| FieldConfig | fromDataModel | If dataModelState is "customized", you will find here the
original object generated by the data model. Use this to easily revert to "auto" state from "customized". |
| ListsEncoderConfig | - | Configuration of the inverted lists encoder. If no configuration is specified, a Rice encoder is used. |
| Name | Type | Default value | Description |
| ramBased | boolean | False | A value field must be RAM-based to perform synthesis efficiently. |
| multiContext | boolean | False | |
| fieldName | string | - | The name of the field. The name of a field can only contain lower-case characters, numbers and underscore. [a-z0-9_]+ |
| searchable | boolean | False | Allows users to query on this field (using a prefix handler). |
| retrievable | boolean | False | Allows the content of this field to be retrieved at query time and displayed in the search results. |
| dataModelState | string | - | Is this index field config managed by a data model?
@enum{null,auto,customized}. If null, this is not related to a data model. If "auto", this is auto-generated by a data model. If "customized", this was auto-generated by a data model and then customized. |
| dataModelClass | string | - | If dataModelState is "auto" or customized", you will find here the name of the DataModelClass that generated this field config. |
| dataModelProperty | string | - | If dataModelState is "auto" or customized", you will find here the name of the DataModelProperty that generated this field config. |
| multivalued | boolean | False | |
| version | int | 0 |
| Type | Wrapper | Description |
| FieldConfig | fromDataModel | If dataModelState is "customized", you will find here the
original object generated by the data model. Use this to easily revert to "auto" state from "customized". |
| ListsEncoderConfig | - | Configuration of the inverted lists encoder. If no configuration is specified, a Rice encoder is used. |
| Name | Type | Default value | Description |
| ramBased | boolean | False | A value field must be RAM-based to perform synthesis efficiently. |
| multiContext | boolean | False | |
| fieldName | string | - | The name of the field. The name of a field can only contain lower-case characters, numbers and underscore. [a-z0-9_]+ |
| searchable | boolean | False | Allows users to query on this field (using a prefix handler). |
| retrievable | boolean | False | Allows the content of this field to be retrieved at query time and displayed in the search results. |
| dataModelState | string | - | Is this index field config managed by a data model?
@enum{null,auto,customized}. If null, this is not related to a data model. If "auto", this is auto-generated by a data model. If "customized", this was auto-generated by a data model and then customized. |
| dataModelClass | string | - | If dataModelState is "auto" or customized", you will find here the name of the DataModelClass that generated this field config. |
| dataModelProperty | string | - | If dataModelState is "auto" or customized", you will find here the name of the DataModelProperty that generated this field config. |
| multivalued | boolean | False | |
| version | int | 0 | |
| geoType | enum(WGS84, Meter) | WGS84 | Value can be one of
|
| blockSize | int | 8192 | |
| exact | boolean | True |
| Type | Wrapper | Description |
| FieldConfig | fromDataModel | If dataModelState is "customized", you will find here the
original object generated by the data model. Use this to easily revert to "auto" state from "customized". |
| ListsEncoderConfig | - | Configuration of the inverted lists encoder. If no configuration is specified, a Rice encoder is used. |
| Name | Type | Default value | Description |
| ramBased | boolean | False | A value field must be RAM-based to perform synthesis efficiently. |
| multiContext | boolean | False | |
| fieldName | string | - | The name of the field. The name of a field can only contain lower-case characters, numbers and underscore. [a-z0-9_]+ |
| searchable | boolean | False | Allows users to query on this field (using a prefix handler). |
| retrievable | boolean | False | Allows the content of this field to be retrieved at query time and displayed in the search results. |
| dataModelState | string | - | Is this index field config managed by a data model?
@enum{null,auto,customized}. If null, this is not related to a data model. If "auto", this is auto-generated by a data model. If "customized", this was auto-generated by a data model and then customized. |
| dataModelClass | string | - | If dataModelState is "auto" or customized", you will find here the name of the DataModelClass that generated this field config. |
| dataModelProperty | string | - | If dataModelState is "auto" or customized", you will find here the name of the DataModelProperty that generated this field config. |
| multivalued | boolean | False | |
| version | int | 0 | |
| geoType | enum(Meter) | Meter | Value can be one of
|
| maxBlockSize | int | 24 | |
| precision | int | 6 | |
| bboxFieldName | string | - |
| Type | Wrapper | Description |
| FieldConfig | fromDataModel | If dataModelState is "customized", you will find here the
original object generated by the data model. Use this to easily revert to "auto" state from "customized". |
| ListsEncoderConfig | - | Configuration of the inverted lists encoder. If no configuration is specified, a Rice encoder is used. |
| Name | Type | Default value | Description |
| ramBased | boolean | False | A value field must be RAM-based to perform synthesis efficiently. |
| multiContext | boolean | False | |
| fieldName | string | - | The name of the field. The name of a field can only contain lower-case characters, numbers and underscore. [a-z0-9_]+ |
| searchable | boolean | False | Allows users to query on this field (using a prefix handler). |
| retrievable | boolean | False | Allows the content of this field to be retrieved at query time and displayed in the search results. |
| dataModelState | string | - | Is this index field config managed by a data model?
@enum{null,auto,customized}. If null, this is not related to a data model. If "auto", this is auto-generated by a data model. If "customized", this was auto-generated by a data model and then customized. |
| dataModelClass | string | - | If dataModelState is "auto" or customized", you will find here the name of the DataModelClass that generated this field config. |
| dataModelProperty | string | - | If dataModelState is "auto" or customized", you will find here the name of the DataModelProperty that generated this field config. |
| multivalued | boolean | False | |
| version | int | 0 | |
| dictStorage | enum(strbtree, trie, fsm) | fsm | Associative array implementation. |
| bitsetThreshold | int | 10000 | Number of requested documents before switching from a dynamic array to a bitset representation. |
| Type | Wrapper | Description |
| FieldConfig | fromDataModel | If dataModelState is "customized", you will find here the
original object generated by the data model. Use this to easily revert to "auto" state from "customized". |
| ListsEncoderConfig | - | Configuration of the inverted lists encoder. If no configuration is specified, a Rice encoder is used. |
| Name | Type | Default value | Description |
| deltaRefEncodeMultivaluedValues | boolean | True | Delta ref encode multivalued values. |
| sortMultivaluedValues | boolean | True | Storing multivalued RAM-based values in an increasing order consumes less RAM. This must be disabled to use some advanced multivalued virtual functions. |
| ramBased | boolean | False | A value field must be RAM-based to perform synthesis efficiently. |
| multiContext | boolean | False | |
| fieldName | string | - | The name of the field. The name of a field can only contain lower-case characters, numbers and underscore. [a-z0-9_]+ |
| searchable | boolean | False | Allows users to query on this field (using a prefix handler). |
| retrievable | boolean | False | Allows the content of this field to be retrieved at query time and displayed in the search results. |
| dataModelState | string | - | Is this index field config managed by a data model?
@enum{null,auto,customized}. If null, this is not related to a data model. If "auto", this is auto-generated by a data model. If "customized", this was auto-generated by a data model and then customized. |
| dataModelClass | string | - | If dataModelState is "auto" or customized", you will find here the name of the DataModelClass that generated this field config. |
| dataModelProperty | string | - | If dataModelState is "auto" or customized", you will find here the name of the DataModelProperty that generated this field config. |
| multivalued | boolean | False | |
| version | int | 0 | |
| ignorePresentBit | boolean | False | Uses and loads the present bit. |
| minMemberNbBits | int | 5 | Min number of bits for attr part for value field. |
| bloomFilter | boolean | False | Activates a Bloom filter per slot. This speeds up requests containing words that are not present in the field on a given slot. Disable this option if all words of the request for this field are always matching, and if you compact into big slots regularly. Enable this option if there is either a lot of misses (e.g. on the "text" field) or if you have small updates (e.g. with real-time indexing). |
| hashThreshold | int | 128 | Stores a hash value in field dictionary instead of the original data if value length is greater than this threshold. |
| implementation | enum(strbtree, fsm) | fsm | Advanced configuration. Internal structure used to store the field dictionary. |
| optimizeListsForPatternSearch | boolean | False | speed up pattern search by reducing the number of opened inverted lists at the expense of indexing time and disk space. |
| Type | Wrapper | Description |
| FieldConfig | fromDataModel | If dataModelState is "customized", you will find here the
original object generated by the data model. Use this to easily revert to "auto" state from "customized". |
| ListsEncoderConfig | - | Configuration of the inverted lists encoder. If no configuration is specified, a Rice encoder is used. |
| Name | Type | Default value | Description |
| ramBased | boolean | True | A value field must be RAM-based to perform synthesis efficiently. |
| multiContext | boolean | False | |
| retrievable | boolean | True | |
| ignorePresentBit | boolean | False | Uses and loads the present bit. |
| minMemberNbBits | int | 5 | Min number of bits for attr part for value field. |
| bloomFilter | boolean | False | Activates a Bloom filter per slot. This speeds up requests containing words that are not present in the field on a given slot. Disable this option if all words of the request for this field are always matching, and if you compact into big slots regularly. Enable this option if there is either a lot of misses (e.g. on the "text" field) or if you have small updates (e.g. with real-time indexing). |
| hashThreshold | int | 128 | Stores a hash value in field dictionary instead of the original data if value length is greater than this threshold. |
| implementation | enum(strbtree, fsm) | fsm | Advanced configuration. Internal structure used to store the field dictionary. |
| optimizeListsForPatternSearch | boolean | False | speed up pattern search by reducing the number of opened inverted lists at the expense of indexing time and disk space. |
| deltaRefEncodeMultivaluedValues | boolean | True | Delta ref encode multivalued values. |
| sortMultivaluedValues | boolean | True | Storing multivalued RAM-based values in an increasing order consumes less RAM. This must be disabled to use some advanced multivalued virtual functions. |
| fieldName | string | - | The name of the field. The name of a field can only contain lower-case characters, numbers and underscore. [a-z0-9_]+ |
| searchable | boolean | False | Allows users to query on this field (using a prefix handler). |
| dataModelState | string | - | Is this index field config managed by a data model?
@enum{null,auto,customized}. If null, this is not related to a data model. If "auto", this is auto-generated by a data model. If "customized", this was auto-generated by a data model and then customized. |
| dataModelClass | string | - | If dataModelState is "auto" or customized", you will find here the name of the DataModelClass that generated this field config. |
| dataModelProperty | string | - | If dataModelState is "auto" or customized", you will find here the name of the DataModelProperty that generated this field config. |
| multivalued | boolean | False | |
| version | int | 0 | |
| storePositions | boolean | True | Store positions for seq nodes and proximity scoring. |
| Type | Wrapper | Description |
| FieldConfig | fromDataModel | If dataModelState is "customized", you will find here the
original object generated by the data model. Use this to easily revert to "auto" state from "customized". |
| ListsEncoderConfig | - | Configuration of the inverted lists encoder. If no configuration is specified, a Rice encoder is used. |
| Name | Type | Default value | Description |
| ramBased | boolean | True | A value field must be RAM-based to perform synthesis efficiently. |
| multiContext | boolean | False | |
| retrievable | boolean | True | |
| ignorePresentBit | boolean | False | Uses and loads the present bit. |
| minMemberNbBits | int | 5 | Min number of bits for attr part for value field. |
| bloomFilter | boolean | False | Activates a Bloom filter per slot. This speeds up requests containing words that are not present in the field on a given slot. Disable this option if all words of the request for this field are always matching, and if you compact into big slots regularly. Enable this option if there is either a lot of misses (e.g. on the "text" field) or if you have small updates (e.g. with real-time indexing). |
| hashThreshold | int | 128 | Stores a hash value in field dictionary instead of the original data if value length is greater than this threshold. |
| implementation | enum(strbtree, fsm) | fsm | Advanced configuration. Internal structure used to store the field dictionary. |
| optimizeListsForPatternSearch | boolean | False | speed up pattern search by reducing the number of opened inverted lists at the expense of indexing time and disk space. |
| deltaRefEncodeMultivaluedValues | boolean | True | Delta ref encode multivalued values. |
| sortMultivaluedValues | boolean | True | Storing multivalued RAM-based values in an increasing order consumes less RAM. This must be disabled to use some advanced multivalued virtual functions. |
| fieldName | string | - | The name of the field. The name of a field can only contain lower-case characters, numbers and underscore. [a-z0-9_]+ |
| searchable | boolean | False | Allows users to query on this field (using a prefix handler). |
| dataModelState | string | - | Is this index field config managed by a data model?
@enum{null,auto,customized}. If null, this is not related to a data model. If "auto", this is auto-generated by a data model. If "customized", this was auto-generated by a data model and then customized. |
| dataModelClass | string | - | If dataModelState is "auto" or customized", you will find here the name of the DataModelClass that generated this field config. |
| dataModelProperty | string | - | If dataModelState is "auto" or customized", you will find here the name of the DataModelProperty that generated this field config. |
| multivalued | boolean | False | |
| version | int | 0 |
| Type | Wrapper | Description |
| FieldConfig | fromDataModel | If dataModelState is "customized", you will find here the
original object generated by the data model. Use this to easily revert to "auto" state from "customized". |
| ListsEncoderConfig | - | Configuration of the inverted lists encoder. If no configuration is specified, a Rice encoder is used. |
| Name | Type | Default value | Description |
| bitsForValue | int | 63 | Number of bits used to store numerical values. For unsigned numerical fields, the possible values are [0; 2^N - 1], and the field values are stored on N bits. For signed fields (signed integer and double), the possible values are [-2^N, 2^N - 1], and the field values are stored on (N+1) bits. |
| blockSize | int | 8192 | |
| deltaRefEncodeMultivaluedValues | boolean | True | Delta ref encode multivalued values. |
| sortMultivaluedValues | boolean | True | Storing multivalued RAM-based values in an increasing order consumes less RAM. This must be disabled to use some advanced multivalued virtual functions. |
| ramBased | boolean | False | A value field must be RAM-based to perform synthesis efficiently. |
| multiContext | boolean | False | |
| fieldName | string | - | The name of the field. The name of a field can only contain lower-case characters, numbers and underscore. [a-z0-9_]+ |
| searchable | boolean | False | Allows users to query on this field (using a prefix handler). |
| retrievable | boolean | False | Allows the content of this field to be retrieved at query time and displayed in the search results. |
| dataModelState | string | - | Is this index field config managed by a data model?
@enum{null,auto,customized}. If null, this is not related to a data model. If "auto", this is auto-generated by a data model. If "customized", this was auto-generated by a data model and then customized. |
| dataModelClass | string | - | If dataModelState is "auto" or customized", you will find here the name of the DataModelClass that generated this field config. |
| dataModelProperty | string | - | If dataModelState is "auto" or customized", you will find here the name of the DataModelProperty that generated this field config. |
| multivalued | boolean | False | |
| version | int | 0 |
| Type | Wrapper | Description |
| FieldConfig | fromDataModel | If dataModelState is "customized", you will find here the
original object generated by the data model. Use this to easily revert to "auto" state from "customized". |
| ListsEncoderConfig | - | Configuration of the inverted lists encoder. If no configuration is specified, a Rice encoder is used. |
| Name | Type | Default value | Description |
| bitsForValue | int | 63 | Number of bits used to store numerical values. For unsigned numerical fields, the possible values are [0; 2^N - 1], and the field values are stored on N bits. For signed fields (signed integer and double), the possible values are [-2^N, 2^N - 1], and the field values are stored on (N+1) bits. |
| blockSize | int | 8192 | |
| deltaRefEncodeMultivaluedValues | boolean | True | Delta ref encode multivalued values. |
| sortMultivaluedValues | boolean | True | Storing multivalued RAM-based values in an increasing order consumes less RAM. This must be disabled to use some advanced multivalued virtual functions. |
| ramBased | boolean | False | A value field must be RAM-based to perform synthesis efficiently. |
| multiContext | boolean | False | |
| fieldName | string | - | The name of the field. The name of a field can only contain lower-case characters, numbers and underscore. [a-z0-9_]+ |
| searchable | boolean | False | Allows users to query on this field (using a prefix handler). |
| retrievable | boolean | False | Allows the content of this field to be retrieved at query time and displayed in the search results. |
| dataModelState | string | - | Is this index field config managed by a data model?
@enum{null,auto,customized}. If null, this is not related to a data model. If "auto", this is auto-generated by a data model. If "customized", this was auto-generated by a data model and then customized. |
| dataModelClass | string | - | If dataModelState is "auto" or customized", you will find here the name of the DataModelClass that generated this field config. |
| dataModelProperty | string | - | If dataModelState is "auto" or customized", you will find here the name of the DataModelProperty that generated this field config. |
| multivalued | boolean | False | |
| version | int | 0 |
| Type | Wrapper | Description |
| FieldConfig | fromDataModel | If dataModelState is "customized", you will find here the
original object generated by the data model. Use this to easily revert to "auto" state from "customized". |
| ListsEncoderConfig | - | Configuration of the inverted lists encoder. If no configuration is specified, a Rice encoder is used. |
| Name | Type | Default value | Description |
| bitsForValue | int | 63 | Number of bits used to store numerical values. For unsigned numerical fields, the possible values are [0; 2^N - 1], and the field values are stored on N bits. For signed fields (signed integer and double), the possible values are [-2^N, 2^N - 1], and the field values are stored on (N+1) bits. |
| blockSize | int | 8192 | |
| deltaRefEncodeMultivaluedValues | boolean | True | Delta ref encode multivalued values. |
| sortMultivaluedValues | boolean | True | Storing multivalued RAM-based values in an increasing order consumes less RAM. This must be disabled to use some advanced multivalued virtual functions. |
| ramBased | boolean | False | A value field must be RAM-based to perform synthesis efficiently. |
| multiContext | boolean | False | |
| fieldName | string | - | The name of the field. The name of a field can only contain lower-case characters, numbers and underscore. [a-z0-9_]+ |
| searchable | boolean | False | Allows users to query on this field (using a prefix handler). |
| retrievable | boolean | False | Allows the content of this field to be retrieved at query time and displayed in the search results. |
| dataModelState | string | - | Is this index field config managed by a data model?
@enum{null,auto,customized}. If null, this is not related to a data model. If "auto", this is auto-generated by a data model. If "customized", this was auto-generated by a data model and then customized. |
| dataModelClass | string | - | If dataModelState is "auto" or customized", you will find here the name of the DataModelClass that generated this field config. |
| dataModelProperty | string | - | If dataModelState is "auto" or customized", you will find here the name of the DataModelProperty that generated this field config. |
| multivalued | boolean | False | |
| version | int | 0 | |
| precision | int | 4 | Number of relevant digits in the decimal part. |
| Type | Wrapper | Description |
| FieldConfig | fromDataModel | If dataModelState is "customized", you will find here the
original object generated by the data model. Use this to easily revert to "auto" state from "customized". |
| ListsEncoderConfig | - | Configuration of the inverted lists encoder. If no configuration is specified, a Rice encoder is used. |
| Name | Type | Default value | Description |
| deltaRefEncodeMultivaluedValues | boolean | True | Delta ref encode multivalued values. |
| sortMultivaluedValues | boolean | True | Storing multivalued RAM-based values in an increasing order consumes less RAM. This must be disabled to use some advanced multivalued virtual functions. |
| ramBased | boolean | False | A value field must be RAM-based to perform synthesis efficiently. |
| multiContext | boolean | False | |
| fieldName | string | - | The name of the field. The name of a field can only contain lower-case characters, numbers and underscore. [a-z0-9_]+ |
| searchable | boolean | False | Allows users to query on this field (using a prefix handler). |
| retrievable | boolean | False | Allows the content of this field to be retrieved at query time and displayed in the search results. |
| dataModelState | string | - | Is this index field config managed by a data model?
@enum{null,auto,customized}. If null, this is not related to a data model. If "auto", this is auto-generated by a data model. If "customized", this was auto-generated by a data model and then customized. |
| dataModelClass | string | - | If dataModelState is "auto" or customized", you will find here the name of the DataModelClass that generated this field config. |
| dataModelProperty | string | - | If dataModelState is "auto" or customized", you will find here the name of the DataModelProperty that generated this field config. |
| multivalued | boolean | False | |
| version | int | 0 |
| Type | Wrapper | Description |
| FieldConfig | fromDataModel | If dataModelState is "customized", you will find here the
original object generated by the data model. Use this to easily revert to "auto" state from "customized". |
| ListsEncoderConfig | - | Configuration of the inverted lists encoder. If no configuration is specified, a Rice encoder is used. |
| Name | Type | Default value | Description |
| deltaRefEncodeMultivaluedValues | boolean | True | Delta ref encode multivalued values. |
| sortMultivaluedValues | boolean | True | Storing multivalued RAM-based values in an increasing order consumes less RAM. This must be disabled to use some advanced multivalued virtual functions. |
| ramBased | boolean | False | A value field must be RAM-based to perform synthesis efficiently. |
| multiContext | boolean | False | |
| fieldName | string | - | The name of the field. The name of a field can only contain lower-case characters, numbers and underscore. [a-z0-9_]+ |
| searchable | boolean | False | Allows users to query on this field (using a prefix handler). |
| retrievable | boolean | False | Allows the content of this field to be retrieved at query time and displayed in the search results. |
| dataModelState | string | - | Is this index field config managed by a data model?
@enum{null,auto,customized}. If null, this is not related to a data model. If "auto", this is auto-generated by a data model. If "customized", this was auto-generated by a data model and then customized. |
| dataModelClass | string | - | If dataModelState is "auto" or customized", you will find here the name of the DataModelClass that generated this field config. |
| dataModelProperty | string | - | If dataModelState is "auto" or customized", you will find here the name of the DataModelProperty that generated this field config. |
| multivalued | boolean | False | |
| version | int | 0 |
| Type | Wrapper | Description |
| FieldConfig | fromDataModel | If dataModelState is "customized", you will find here the
original object generated by the data model. Use this to easily revert to "auto" state from "customized". |
| ListsEncoderConfig | - | Configuration of the inverted lists encoder. If no configuration is specified, a Rice encoder is used. |
| Name | Type | Default value | Description |
| ramBased | boolean | False | A value field must be RAM-based to perform synthesis efficiently. |
| multiContext | boolean | False | |
| fieldName | string | - | The name of the field. The name of a field can only contain lower-case characters, numbers and underscore. [a-z0-9_]+ |
| searchable | boolean | False | Allows users to query on this field (using a prefix handler). |
| retrievable | boolean | False | Allows the content of this field to be retrieved at query time and displayed in the search results. |
| dataModelState | string | - | Is this index field config managed by a data model?
@enum{null,auto,customized}. If null, this is not related to a data model. If "auto", this is auto-generated by a data model. If "customized", this was auto-generated by a data model and then customized. |
| dataModelClass | string | - | If dataModelState is "auto" or customized", you will find here the name of the DataModelClass that generated this field config. |
| dataModelProperty | string | - | If dataModelState is "auto" or customized", you will find here the name of the DataModelProperty that generated this field config. |
| multivalued | boolean | False | |
| version | int | 0 | |
| gzip | boolean | False | Activates content compression |
| Type | Wrapper | Description |
| FieldConfig | fromDataModel | If dataModelState is "customized", you will find here the
original object generated by the data model. Use this to easily revert to "auto" state from "customized". |
| ListsEncoderConfig | - | Configuration of the inverted lists encoder. If no configuration is specified, a Rice encoder is used. |
| Name | Type | Default value | Description |
| fieldName | string | - | The name of the field. The name of a field can only contain lower-case characters, numbers and underscore. [a-z0-9_]+ |
| searchable | boolean | False | Allows users to query on this field (using a prefix handler). |
| retrievable | boolean | False | Allows the content of this field to be retrieved at query time and displayed in the search results. |
| dataModelState | string | - | Is this index field config managed by a data model?
@enum{null,auto,customized}. If null, this is not related to a data model. If "auto", this is auto-generated by a data model. If "customized", this was auto-generated by a data model and then customized. |
| dataModelClass | string | - | If dataModelState is "auto" or customized", you will find here the name of the DataModelClass that generated this field config. |
| dataModelProperty | string | - | If dataModelState is "auto" or customized", you will find here the name of the DataModelProperty that generated this field config. |
| multivalued | boolean | False | |
| version | int | 0 | |
| ramBased | boolean | True | A value field must be RAM-based to perform synthesis efficiently. |
| implementation | enum(strbtree, fsm) | strbtree | Advanced configuration. Internal structure used to store the field dictionary. |
| Type | Wrapper | Description |
| FieldConfig | fromDataModel | If dataModelState is "customized", you will find here the
original object generated by the data model. Use this to easily revert to "auto" state from "customized". |
| ListsEncoderConfig | - | Configuration of the inverted lists encoder. If no configuration is specified, a Rice encoder is used. |
| Name | Type | Default value | Description |
| ramBased | boolean | True | A value field must be RAM-based to perform synthesis efficiently. |
| implementation | enum(strbtree, fsm) | strbtree | Advanced configuration. Internal structure used to store the field dictionary. |
| fieldName | string | - | The name of the field. The name of a field can only contain lower-case characters, numbers and underscore. [a-z0-9_]+ |
| searchable | boolean | False | Allows users to query on this field (using a prefix handler). |
| retrievable | boolean | False | Allows the content of this field to be retrieved at query time and displayed in the search results. |
| dataModelState | string | - | Is this index field config managed by a data model?
@enum{null,auto,customized}. If null, this is not related to a data model. If "auto", this is auto-generated by a data model. If "customized", this was auto-generated by a data model and then customized. |
| dataModelClass | string | - | If dataModelState is "auto" or customized", you will find here the name of the DataModelClass that generated this field config. |
| dataModelProperty | string | - | If dataModelState is "auto" or customized", you will find here the name of the DataModelProperty that generated this field config. |
| multivalued | boolean | False | |
| version | int | 0 |
| Type | Wrapper | Description |
| FieldConfig | fromDataModel | If dataModelState is "customized", you will find here the
original object generated by the data model. Use this to easily revert to "auto" state from "customized". |
| ListsEncoderConfig | - | Configuration of the inverted lists encoder. If no configuration is specified, a Rice encoder is used. |
| Type | Wrapper | Description |
| AnalysisPolicy | - | |
| CommitTriggerCondition* | - | |
| ImportPolicy | - | |
| IndexManagementPolicy | - | |
| WriteAttributeSlotConfig* | - | |
| WriteSlotConfig | - |
| Name | Type | Default value | Description |
| maxRAMConsumptionThreshold | enum(disabled, enabled, auto) | enabled | When reaching the RAM value specified, analysis is stopped and analyzed documents are imported to the index. Then analysis starts again.
|
| maxRAMConsumptionMB | int | 2048 | The maximum of non-java RAM the analyzer can allocate. Reaching this limit triggers a commit. |
| nbThreads | int | 4 | Number of threads to allocate. |
| Name | Type | Default value | Description |
| maxRAMConsumptionThreshold | enum(disabled, enabled, auto) | enabled | When reaching the RAM value specified, analysis is stopped and analyzed documents are imported to the index. Then analysis starts again.
|
| maxRAMConsumptionMB | int | 2048 | The maximum of non-java RAM the analyzer can allocate. Reaching this limit triggers a commit. |
| nbThreads | int | 1 | Uses N threads per slice. |
| Name | Type | Default value | Description |
| maxRAMConsumptionThreshold | enum(disabled, enabled, auto) | enabled | When reaching the RAM value specified, analysis is stopped and analyzed documents are imported to the index. Then analysis starts again.
|
| maxRAMConsumptionMB | int | 2048 | The maximum of non-java RAM the analyzer can allocate. Reaching this limit triggers a commit. |
| Name | Type | Default value | Description |
| maxRAMConsumptionThreshold | enum(disabled, enabled, auto) | enabled | When reaching the RAM value specified, analysis is stopped and analyzed documents are imported to the index. Then analysis starts again.
|
| maxRAMConsumptionMB | int | 2048 | The maximum of non-java RAM the analyzer can allocate. Reaching this limit triggers a commit. |
| nbThreads | int | 0 | If not set or set with a multiple of 'nbSlices', it uses the 'PerSliceAnalysisPolicy'. Otherwise, it uses 'FixedThreadsAnalysisPolicy'. |
| Name | Type | Default value | Description |
| nbTasks | int | - | The number of tasks |
| Name | Type | Default value | Description |
| maxSizeMB | int | - | Max size threshold in MB |
| Name | Type | Default value | Description |
| maxRAMUsageInMB | int | - | Max RAM usage in MB |
| Name | Type | Default value | Description |
| delayS | long | - | Time in seconds between two commits. |
| Name | Type | Default value | Description |
| numberOfTasks | int | - | Minimum number of tasks to trigger a commit. |
| inactivityTimeS | long | - | After N seconds of no indexing activity, it is defined as inactive. |
| inactivityTimeMs | long | - | After N milliseconds of no indexing activity, it is defined as inactive. If both timeS and timeMs are set, wait 1000*timeS + timeMs milliseconds. |
| Name | Type | Default value | Description |
| nbThreads | int | 8 | The number of parallel import. |
| Name | Type | Default value | Description |
| gcEveryS | int | 120 | Trigger a GC every N seconds. |
| Type | Wrapper | Description |
| CommitPolicy | - | The commit policy used to configured how the index persists its file to disk. |
| CompactPolicies | - | The compact policies used to trigger slots compaction. |
| UploadPolicy | - | The upload policy used to replicate new slots to replicas. |
| Name | Type | Default value | Description |
| synchronous | boolean | False | By default, compaction jobs are asynchronous. If set, compacts will be done synchronously just after imports. |
| maxParallelFullCompacts | int | 0 | Limit the number of full compacts in parallel, can be useful when you don't have too much disk space available. 0 means no limit. |
| type | enum(mmap, pagecache) | mmap | Specifies which I/O mode is used while compacting. ( Value can be null or one of
|
| maxPageCacheSizeMB | int | 32 | If the policy uses the PageCache mode, it specifies the max cache size. |
| pageCachePageSizeKB | int | 8 | If the policy uses the PageCache mode, it specifies the page size. |
| priorityCompactThreshold | int | 64 | When compacting a slot gen0-gen1, consider as a priority compact if gen1-gen0 < priorityCompactThreshold. Default is 48. (0: disabled) |
| lowPriorityCompactNbThreads | int | 2 | Number of threads to use for a compact having low priority (0: all available threads). |
| highPriorityCompactNbThreads | int | 0 | Number of threads to use for a compact having high priority (0: all available threads). |
| Type | Wrapper | Description |
| AutoCompactPolicy* | - | Specifies the auto-compact policies. |
| Name | Type | Default value | Description |
| component | string | - | |
| arity | int | 4 | Specifies the number of slots of the same length required to compact. |
| maxSlotSizeMb | long | 5000 | If a slot reaches this size; it will never be used by the next automatic compaction processes. |
| Type | Wrapper | Description |
| FullCompactPolicy | - |
| Name | Type | Default value | Description |
| percentage | int | 100 | Minimum percentage to launch a full compaction. Compacts all slots into one whenever the "tail" of small slots exceeds a certain percentage of the large first slot. Eg: with percentage=100, when cumulated size of all slots except biggest is higher than size of the biggest slot, a full compact is triggered. |
| minSlots | int | 2 | Minimum number of slots before triggering a full compact. |
| Name | Type | Default value | Description |
| maxArity | int | 256 | Whenever the long tail total arity reaches maxArity, a full compact is scheduled. The "long tail" are the slots whose span has an arity inferior to this parameter. This is generally a multiple of the auto-compact Arity policy arity parameter. |
| minSize | long | 0 | Slots below this size are considered neglectable. |
| Name | Type | Default value | Description |
| component | string | - | |
| targetSizeForCompactionMB | int | 200 | Targeted size for a compacted slot. |
| minSizeForCompactionMB | int | 50 | Minimum size required to compact. |
| minArity | int | 2 | Minimum number of slots required to compact. |
| Type | Wrapper | Description |
| FullCompactPolicy | - |
| Name | Type | Default value | Description |
| component | string | - | |
| compactFactor | int | 10 | Determines how often slots are compacted. With smaller values, less RAM is used while indexing, and searches on unoptimized indices are faster, but indexing speed is slower. With larger values, more RAM is used during indexing, and while searches on unoptimized indices are slower, indexing is faster. Thus larger values (greater than 10) are best for batch index creation, and smaller values (lower than 10) for indices that are interactively maintained. |
| minSize | long | 1048576 | A size setting type which sets the minimum size for the lowest level slots. Slots below this size are considered to be on the same level (even if they vary drastically in size) and will be merged whenever there are mergeFactor for them. This effectively truncates the "long tail" of small slots that would otherwise be created into a single level. If you set this too large, it can greatly increase the merging cost during indexing (if you flush many small slots). |
| maxSize | long | 9223372036854775807 | A size setting type which sets the largest slot that may be merged with other segments. |
| Type | Wrapper | Description |
| FullCompactPolicy | - |
| Name | Type | Default value | Description |
| component | string | - | |
| nbLargeSlots | int | 8 | The number of large slots to keep. |
| maxNbSmallSlots | int | 8 | Maximum number of small slots allowed. As soon as this limit is reached, small slots are compacted together. |
| gatherSmallsAtTheEnd | boolean | True | |
| contiguousCompact | boolean | False |
| Type | Wrapper | Description |
| FullCompactPolicy | - |
| Name | Type | Default value | Description |
| component | string | - |
| Type | Wrapper | Description |
| FullCompactPolicy | - |
| Name | Type | Default value | Description |
| waitBetweenSwitchesS | int | - | If strictly positive, all slices switch to a generation sequentially, and we wait this time in seconds between two slices. This spreads the temporary memory consumption to avoid large memory spikes and swap out. |
| Name | Type | Default value | Description |
| type | enum(directio, sequential) | directio | Access type for writing the new slots. Value can be null or one of
|
| groupId | int | - | Specifies which attribute group store this access configuration applies to. |
| Name | Type | Default value | Description |
| type | enum(directio, sequential) | sequential | Access type for writing the new slots. Value can be null or one of
|
| Type | Wrapper | Description |
| CacheConfig* | - | Lists PageCache configurations |
| IndexRuntimeConfig* | - | Lists runtime configurations |
| Name | Type | Default value | Description |
| name | string | - | The cache ID. |
| cacheSizeMB | int | 256 | Maximum cache size in MB. |
| pageSizeKB | int | 8 | Page size in KB. |
| maxSimultaneousIOOperations | int | 32 | Specifies the max number of simultaneous I/O. |
| Name | Type | Default value | Description |
| name | string | - | |
| newGenerationBandwidthLimitKB | int | 0 | |
| compactBandwidthLimitKB | int | 0 | |
| ramBasedAttrGroupLoadPolicy | enum(rebuild, copyAndPatch) | copyAndPatch | Value can be one of
|
| Type | Wrapper | Description |
| AttributeGroupAccess* | - | |
| FieldRuntimeConfig* | - | |
| QueryAutocacheConfig | - | |
| ReplicationConfig | - | |
| WarmupConfig | - |
| Name | Type | Default value | Description |
| groupId | string | - | Specifies which attribute group store this access configuration applies to. |
| runType | enum(mmap, pagecache, direct, RAMRow, RAMColumnDense) | mmap | Specifies how the attribute group should be accessed at runtime. |
| preload | boolean | False | For RAM-based access type, specifies if the attribute group should be loaded in RAM at startup instead of at access time. |
| mlock | boolean | False | For RAM-based access type, specifies if the attribute group should be locked in RAM. Preventing it being moved to the swap area. |
| cacheId | string | - | For pagecache I/O type, specifies the cache ID. |
| Name | Type | Default value | Description |
| name | string | - | The index field name. |
| dictType | enum(mmap, pagecache) | mmap | Specifies the I/O mode used to load the dictionary part of an index field. ( Value can be one of
|
| type | enum(mmap, pagecache) | mmap | Specifies the I/O mode used to load the component. ( Value can be one of
|
| preload | boolean | False | Should the field be preloaded? This will force the field to be loaded in RAM at startup. |
| mlock | boolean | False | Should the field be locked in RAM. |
| cacheId | string | - | If PageCache is used, it specifies the cache ID. |
| Name | Type | Default value | Description |
| totalCacheSizeMB | int | 20 | Maximum cache size in MB (cross queries). |
| queryCacheSizeMB | int | 5 | Maximum cached query size. |
| maxCachedQueries | int | 20 | Number of queries cached. |
| Type | Wrapper | Description |
| AttributeReplicationConfig* | - | Configures the direction usage in attribute replication. |
| FieldReplicationConfig* | - | Configures the direction usage in field replication. |
| Name | Type | Default value | Description |
| groupId | string | - | Group id of the attribute to configure |
| type | enum(directio, sequential) | directio | Access type Value can be null or one of
|
| Name | Type | Default value | Description |
| name | string | - | Name of the field to configure. |
| type | enum(directio, sequential) | directio | Access type Value can be null or one of
|
| dictType | enum(directio, sequential) | directio | Access type for the dictionary Value can be null or one of
|
| Name | Type | Default value | Description |
| warmupQueryFile | string | - | Warmup list of single queries |
| maxWarmupDurationS | int | 5 | Maximum time for warmup. Open the index after and prints a warning indicating which line number has been reached |
| Name | Type | Default value | Description |
| buildGroup | string | - | Name of the build group. This name should be unique. |
| dataModel | string | - | Name of the data model. |
| indexingConfig | string | - | Name of an indexing configuration (IndexingConfig element in Indexing MAMI). |
| Type | Wrapper | Description |
| DIHConfig | - | |
| DidAllocationPolicy | - | |
| DocumentCacheConfig | - | |
| PrecomputedThumbnailsConfig | - | |
| ScratchHook* | - | |
| SlicePartioningPolicy | - |
| Name | Type | Default value | Description |
| compactArity | int | 4 | Number of consecutive slots to trigger a compact. |
| nbBloomBitsPerElement | int | 20 | Number of bits per elements in the DIH's StrBTree's bloom filter. |
| nbElementsInLeaf | int | 100 | Number of entries in each of the DIH's StrBTree's leaves. |
| readMode | enum(auto, direct, mmap, mmap_mlock, mmap_mload, pagecache, random, sequential) | mmap | Read mode of the DIH's StrBTree, except for enumeration. Value can be null or one of
|
| enumMode | enum(auto, direct, mmap, mmap_mlock, mmap_mload, pagecache, random, sequential) | mmap | Read mode of the DIH's StrBTree, for enumeration. Value can be null or one of
|
| compactMode | enum(auto, direct, mmap, mmap_mlock, mmap_mload, pagecache, random, sequential) | mmap | Read mode of the DIH's StrBTree, for compact. Value can be null or one of
|
| Name | Type | Default value | Description |
| increasing | boolean | True | Assign DIDs in an increasing order. |
| startingPoint | int | 0 | Start point of the allocation. By default, the first DID will have value '1'. |
| endingPoint | nullableint | - | End point of the allocation. By default, it will be Integer.MAX_VALUE if increasing or 1 if decreasing. |
| Name | Type | Default value | Description |
| path | string | - | Location of the document cache on the filesystem. Unless otherwise specified, the document cache is located in the "cache" subdirectory of the build group. |
| compactArity | int | 4 | Number of consecutive slots to trigger a compact. |
| nbBloomBitsPerElement | int | 10 | Number of bits per element in the document cache StrBTree bloom filter. |
| nbElementsInLeaf | int | 20 | Number of entries in each of the document cache StrBTree leaves. |
| readMode | enum(auto, direct, mmap, mmap_mlock, mmap_mload, pagecache, random, sequential) | auto | Read mode of the document cache StrBTree, except for enumeration. Value can be null or one of
|
| enumMode | enum(auto, direct, mmap, mmap_mlock, mmap_mload, pagecache, random, sequential) | auto | Read mode of the document cache StrBTree, for enumeration. Value can be null or one of
|
| compactMode | enum(auto, direct, mmap, mmap_mlock, mmap_mload, pagecache, random, sequential) | auto | Read mode of the document cache StrBTree, for compact. Value can be null or one of
|
| diskCompressionAlgorithm | enum(none, fastlz, gzip, lcs, lz4) | fastlz | Algorithm to compress the document cache on disk. Value can be null or one of
|
| temporaryFilesCompressionAlgorithm | enum(none, fastlz, gzip, lz4) | fastlz | Algorithm to compress the temporary files on disk. Value can be null or one of
|
| Name | Type | Default value | Description |
| computeThreads | int | 4 |
| Name | Type | Default value | Description |
| computeThreads | int | 4 |
| Name | Type | Default value | Description |
| computeThreads | int | 4 | |
| ramBufferSizeMB | long | 16 | |
| readMode | enum(normal, direct) | direct | Value can be null or one of
|
| Name | Type | Default value | Description |
| classId | string | - | The specified class must implement the {@code com.exalead.mercury.indexing.CustomScratchHook} Exascript interface. |
| Type | Wrapper | Description |
| KeyValue* | - |
| Name | Type | Default value | Description |
| name | string | - | Name of the search logic. This name is referred to with the 'logic' parameter in the Search API. |
| tokenizationConfig | string | - | Name of the tokenization configuration to use when using this search logic. For consistency, this should be the same tokenization configuration as in the dictionary and analysis configurations. |
| dataModel | string | - | Name of the data model this search logic targets. A Search Logic can only target one data model. |
| customQueryProcessingFactoryClassId | string | - | Java class implementing the QueryProcessingRunnerFactory interface to build the thread-specific QueryProcessingRunners (which expand the actual query). |
| fetchMasks | boolean | False | Fetches masks in searcher. Required to get the "mask" field in the hits. |
| sliceDownAction | enum(error, ignore) | ignore | What to do if one of the slice is down when the search is performed. A slice is considered as down if all replicas are down (and if the master is also down in the default search target configuration). One of "error" or "ignore". Default is "ignore". |
| sliceDownReportMode | enum(quiet, local, global) | local | Specifies how to report a down slice error in 'Troubleshooting > Logs':
|
| searchTimeoutAction | enum(error, ignore) | ignore | What to do when slices time out. One of "error" or "ignore". Default is "ignore". |
| searchTimeoutReportMode | enum(quiet, local, global) | local | Specifies how to report a timeout error in 'Troubleshooting > Logs':
|
| searchLimitAction | enum(error, ignore) | ignore | What to do if a search limit is reached. One of "error" or "ignore". Default is "ignore". |
| searchLimitReportMode | enum(quiet, local, global) | local | Specifies how to report a search limit error in 'Troubleshooting > Logs':
|
| retrieveSourceField | boolean | True | Should the "source" field be automatically added to the retrieved field? |
| handleNegativeSecurityTokens | boolean | True | When enabled the security restriction will handle document security token starting with ~ as negative token. The negative security tokens are prioritary above standard tokens. The query restriction generated for a query with the tokens tok1, tok2, tok3 is ((tok1 OR tok2 OR tok3) AND NOT ~tok1 AND NOT ~tok2 AND NOT ~tok3). If the security sources return a lot of security tokens and the connectors do not push negative security tokens it can be interesting to disable negative security tokens handling to speed up the queries (the security query restriction will be (tok1 OR tok2 OR tok3) in this case. |
| Type | Wrapper | Description |
| ContentRestriction | - | Content restriction configuration for this search logic. |
| FacetsConfig | - | Facets configuration for this search logic. |
| HitConfig | - | Hit content configuration for this search logic. |
| LimitsConfig | - | Limits configuration for this search logic. |
| PostFilterConfig | - | Post filtering configuration for this search logic. |
| QueryRestrictionConfig | - | Query restriction configuration for this search logic. |
| RelatedTermsSynthesisConfig | - | Related terms configuration for this search logic. |
| RelevanceConfig | - | Relevance configuration for this search logic. |
| Sort | - | Sort configuration for this search logic. |
| SpellCheckerConfig | - | Spell checker configuration for this search logic. |
| TimezoneConfig | - | |
| UQLConfig | - | UQL configuration for this search logic. |
| VirtualFieldDefinition* | - | Virtual fields configuration for this search logic. |
| Name | Type | Default value | Description |
| queryString | string | - | Query string to restrict content.
Only the documents matching this query string will be taken into consideration. The query string is not subject to any kind of linguistic expansion whatsoever. This query string is AND' ed with the user actual query. |
| Name | Type | Default value | Description |
| maxHits | int | - | Number of hits on which category navigation will be computed. 0 means exhaustive navigation, within the limits of the matched hits. Note: Heapsort executor is used if this setting is defined in ranked mode. If not in ranked mode, this setting is applied per slice. |
| enabled | boolean | True | Enables faceting. |
| optimizedForExhaustiveRankedSynthesis | boolean | True | When search is running in "heap" mode, it locally sorts the DIDs before calculating facets. This decreases significantly LLC miss. |
| categoryArrayBufferSize | int | 1000 | Size of the result blocks sent to the searchserver. This is an optimization parameter. Lower values slightly decrease memory consumption when there is a large number of slices, but increase global CPU consumption. |
| Type | Wrapper | Description |
| Facet* | - | Definition of a facet. |
| Name | Type | Default value | Description |
| id | string | - | Unique identifier of this facet. Used in Mashup-Builder and client applications to identify the facet. |
| type | enum(category, h2d, num_explicit, num_fixed, num_dynamic, geo, autotile, value, multi, enum, date, dyndate, autotilev2, concatvalue) | Used for convenience in various introspection code | |
| refinementPolicy (UI: Refinement policy) |
enum(exclusive, disjunctive, norefine) | exclusive | Defines the Refinements panel behavior.
|
| implementation (UI: Implementation) |
enum(autodetect, favor_cpu, favor_memory) | autodetect | Internal algorithm for implementation of this facet. Value can be null or one of
|
| inNavigation (UI: Use for navigation) |
boolean | True | Computes navigation on this facet. |
| inHits (UI: Use for hit content) |
boolean | True | Computes the value of this facet for each hit. |
| maxSliceCategories (UI: Max categories per slices) |
int | 0 | Maximum number of categories returned by each slice for one facet. 0 means no limit. Warning: Results merged by the search server may be incorrect. |
| sortFunction (UI: Sort by) |
enum(count, relevancy, alphanum, num, range, date, aggregation, explicit, lat, lng) | count | Specifies a sorting function:
|
| aggregateScores (UI: Aggregate scores) |
boolean | False | If selected, the category score will be the sum of the scores of all its hits. |
| root (UI: Root) |
string | - | In the categories field, category values are stored in a tree. The root of the tree is called "Top". |
| maxCategoryTreeDepth (UI: Max. tree depth from current refinement) |
int | 0 | Maximum depth of the returned category tree. Whatever the level of refinement, there will never be more levels retrieved (this ensures we are not overtaking the maxCategoryTreeDepthFromRoot). |
| maxCategoryTreeDepthFromRoot (UI: Max. tree depth from root) |
int | 0 | Maximum depth of the returned category tree, starting from the global root of the category. Setting this attribute to N means that no categories will be kept below this level. |
| categoryField (UI: Index field) |
string | - | Specifies from which field the categories should be retrieved. |
| form (UI: Form) |
enum(exact, lowercase, normalized) | normalized | Normalization form for the category path. Value can be one of
This must match the form with which the category has been mapped at indexing time. |
| hitsMaxCategories (UI: Max. categories in hits) |
int | 100 | Maximum number of facet values displayed in hits. |
| minDocsPerCategory (UI: Min. docs per category) |
int | 1 | Minimum number of docs in a category for it to be included in the Refinements panel. |
| maxCategories (UI: Max. categories) |
int | 0 | Maximum number of categories to display in the facet. 0 means all categories will be displayed. |
| maxCategoriesPerLevel (UI: Max. categories per level) |
int | 100 | Maximum number of facet values in each level of the categories hierarchy. 0 means that all values are selected. The sortFunction is used to select the "best" facet values for each level. |
| sortAggregationFunction (UI: Aggregation function) |
string | - | Aggregation function used to sort by aggregation values. |
| explicitSortOrderValues (UI: Explicit order) |
string | - | Ordered list of values used for explicit sort, comma-separated (use the backslash to escape a comma). |
| reverse (UI: Reverse) |
boolean | False | Reverse sorting order. |
| index | int | - | Internal. |
| dataModelState | string | - | |
| dataModelClass | string | - | If dataModelState is "auto" or "customized", you will find here the name of the DataModelClass that generated this facet. |
| dataModelProperty | string | - | If dataModelState is "auto" or "customized", you will find here the name of the DataModelProperty that generated this facet. |
| Type | Wrapper | Description |
| Facet | fromDataModel | |
| AdditionalFacetView* | - | |
| AggregationFunction* | - | A numerical computation to perform on hits matching each value of the facet. |
| Name | Type | Default value | Description |
| sortFunction (UI: Sort by) |
enum(count, relevancy, alphanum, num, range, date, aggregation, explicit, lat, lng) | count | Specifies a sorting function:
|
| aggregateScores (UI: Aggregate scores) |
boolean | False | If selected, the category score will be the sum of the scores of all its hits. |
| id | string | - | Unique sub-identifier of this view. Will be concatenated to the facet's id. Used in Mashup-Builder and client applications to identify the facet. |
| minDocsPerCategory (UI: Min. docs per category) |
int | 1 | Minimum number of docs in a category for it to be included in the Refinements panel. |
| maxCategories (UI: Max. categories) |
int | 0 | Maximum number of categories to display in the facet. 0 means all categories will be displayed. |
| maxCategoriesPerLevel (UI: Max. categories per level) |
int | 100 | Maximum number of facet values in each level of the categories hierarchy. 0 means that all values are selected. The sortFunction is used to select the "best" facet values for each level. |
| sortAggregationFunction (UI: Aggregation function) |
string | - | Aggregation function used to sort by aggregation values. |
| explicitSortOrderValues (UI: Explicit order) |
string | - | Ordered list of values used for explicit sort, comma-separated (use the backslash to escape a comma). |
| reverse (UI: Reverse) |
boolean | False | Reverse sorting order. |
| Name | Type | Default value | Description |
| id | string | - | Unique sub-identifier of this view. Will be concatenated to the facet's id. Used in Mashup-Builder and client applications to identify the facet. |
| sortFunction (UI: Sort by) |
enum(count, relevancy, alphanum, num, range, date, aggregation, explicit, lat, lng) | count | Specifies a sorting function:
|
| aggregateScores (UI: Aggregate scores) |
boolean | False | If selected, the category score will be the sum of the scores of all its hits. |
| maxCategoryTreeDepth (UI: Max. tree depth from current refinement) |
int | 0 | Maximum number of categories displayed in the facet from the current refinement. Setting this attribute to N means that no categories will be kept below this level. 0 means no limit. |
| maxCategoryTreeDepthFromRoot (UI: Max. tree depth from root) |
int | 0 | Maximum depth of the category tree displayed in the facet from the Top/ level. You can't go further than this limit whatever the refinement level. 0 means no limit. |
| minDocsPerCategory (UI: Min. docs per category) |
int | 1 | Minimum number of docs in a category for it to be included in the Refinements panel. |
| maxCategories (UI: Max. categories) |
int | 0 | Maximum number of categories to display in the facet. 0 means all categories will be displayed. |
| maxCategoriesPerLevel (UI: Max. categories per level) |
int | 100 | Maximum number of facet values in each level of the categories hierarchy. 0 means that all values are selected. The sortFunction is used to select the "best" facet values for each level. |
| sortAggregationFunction (UI: Aggregation function) |
string | - | Aggregation function used to sort by aggregation values. |
| explicitSortOrderValues (UI: Explicit order) |
string | - | Ordered list of values used for explicit sort, comma-separated (use the backslash to escape a comma). |
| reverse (UI: Reverse) |
boolean | False | Reverse sorting order. |
| Name | Type | Default value | Description |
| id | string | - | Unique sub-identifier of this view. Will be concatenated to the facet's id. Used in Mashup-Builder and client applications to identify the facet. |
| sortFunction (UI: Sort by) |
enum(count, relevancy, alphanum, num, range, date, aggregation, explicit, lat, lng) | count | Specifies a sorting function:
|
| aggregateScores (UI: Aggregate scores) |
boolean | False | If selected, the category score will be the sum of the scores of all its hits. |
| withYear | boolean | True | Creates a virtual category for each year. |
| yearDesc | boolean | True | |
| withMonth | boolean | True | Creates a virtual category for each month. |
| monthDesc | boolean | False | |
| withWeek | boolean | False | Creates a virtual category for each week. |
| weekDesc | boolean | False | |
| withDay | boolean | True | Creates a virtual category for each day. |
| dayDesc | boolean | False | |
| withHour | boolean | False | Creates a virtual category for each hour. |
| hourDesc | boolean | False | |
| withMinute | boolean | False | Creates a virtual category for each minute. |
| minuteDesc | boolean | False | |
| withSecond | boolean | False | Creates a virtual category for each second. |
| secondDesc | boolean | False | |
| maxCategoryTreeDepth (UI: Max. tree depth from current refinement) |
int | 0 | Maximum depth of the returned category tree. Whatever the level of refinement, there will never be more levels retrieved (this ensures we are not overtaking the maxCategoryTreeDepthFromRoot). |
| maxCategoryTreeDepthFromRoot (UI: Max. tree depth from root) |
int | 0 | Maximum depth of the returned category tree, starting from the global root of the category. Setting this attribute to N means that no categories will be kept below this level. |
| minDocsPerCategory (UI: Min. docs per category) |
int | 1 | Minimum number of docs in a category for it to be included in the Refinements panel. |
| maxCategories (UI: Max. categories) |
int | 0 | Maximum number of categories to display in the facet. 0 means all categories will be displayed. |
| maxCategoriesPerLevel (UI: Max. categories per level) |
int | 100 | Maximum number of facet values in each level of the categories hierarchy. 0 means that all values are selected. The sortFunction is used to select the "best" facet values for each level. |
| sortAggregationFunction (UI: Aggregation function) |
string | - | Aggregation function used to sort by aggregation values. |
| explicitSortOrderValues (UI: Explicit order) |
string | - | Ordered list of values used for explicit sort, comma-separated (use the backslash to escape a comma). |
| reverse (UI: Reverse) |
boolean | False | Reverse sorting order. |
| Name | Type | Default value | Description |
| id | string | - | Unique identifier of this function. |
| expr | string | - | The expression on which to perform the synthesis. It can reference fields or virtual fields. |
| functionName | string | - | Aggregation function name. We support the following aggregation functions:
|
| Name | Type | Default value | Description |
| expr (UI: Expression) |
string | - | Virtual field expression for this facet. |
| min (UI: Exclude values below) |
nullabledouble | - | Excludes values below this threshold from the facet. |
| max (UI: Exclude values above) |
nullabledouble | - | Excludes values above this threshold from the facet. |
| lsb (UI: Least significant bit) |
int | 0 | Least significant bit of the numerical value to use. Only used for integral types. |
| msb (UI: Most significant bit) |
int | 63 | Most significant bit of the numerical value to use. Only used for integral types. |
| maxValues (UI: Max. categories) |
int | 100 | Maximum number of displayed values. |
| defaultPrecision (UI: Default precision) |
int | 0 | Default precision, in number of trailing digits, for float-typed expressions with double precision (e.g. "#random()"). For example, if defaultPrecision is 2, 0.011 and 0.012 will be considered similar, and categories will be displayed with two significant digits (e.g. [0.00;0.99]) |
| virtualRoot (UI: Virtual root) |
string | - | Path for the resulting root 'virtual' category. When using a virtual facet (a facet which is not stored in a category field), all created categories are attached to a virtual root path. For example: Top/VirtualRoot/[0;5] |
| id | string | - | Unique identifier of this facet. Used in Mashup-Builder and client applications to identify the facet. |
| type | enum(category, h2d, num_explicit, num_fixed, num_dynamic, geo, autotile, value, multi, enum, date, dyndate, autotilev2, concatvalue) | Used for convenience in various introspection code | |
| refinementPolicy (UI: Refinement policy) |
enum(exclusive, disjunctive, norefine) | exclusive | Defines the Refinements panel behavior.
|
| implementation (UI: Implementation) |
enum(autodetect, favor_cpu, favor_memory) | autodetect | Internal algorithm for implementation of this facet. Value can be null or one of
|
| inNavigation (UI: Use for navigation) |
boolean | True | Computes navigation on this facet. |
| inHits (UI: Use for hit content) |
boolean | True | Computes the value of this facet for each hit. |
| maxSliceCategories (UI: Max categories per slices) |
int | 0 | Maximum number of categories returned by each slice for one facet. 0 means no limit. Warning: Results merged by the search server may be incorrect. |
| sortFunction (UI: Sort by) |
enum(count, relevancy, alphanum, num, range, date, aggregation, explicit, lat, lng) | count | Specifies a sorting function:
|
| aggregateScores (UI: Aggregate scores) |
boolean | False | If selected, the category score will be the sum of the scores of all its hits. |
| minDocsPerCategory (UI: Min. docs per category) |
int | 1 | Minimum number of docs in a category for it to be included in the Refinements panel. |
| maxCategories (UI: Max. categories) |
int | 0 | Maximum number of categories to display in the facet. 0 means all categories will be displayed. |
| maxCategoriesPerLevel (UI: Max. categories per level) |
int | 100 | Maximum number of facet values in each level of the categories hierarchy. 0 means that all values are selected. The sortFunction is used to select the "best" facet values for each level. |
| sortAggregationFunction (UI: Aggregation function) |
string | - | Aggregation function used to sort by aggregation values. |
| explicitSortOrderValues (UI: Explicit order) |
string | - | Ordered list of values used for explicit sort, comma-separated (use the backslash to escape a comma). |
| reverse (UI: Reverse) |
boolean | False | Reverse sorting order. |
| index | int | - | Internal. |
| dataModelState | string | - | |
| dataModelClass | string | - | If dataModelState is "auto" or "customized", you will find here the name of the DataModelClass that generated this facet. |
| dataModelProperty | string | - | If dataModelState is "auto" or "customized", you will find here the name of the DataModelProperty that generated this facet. |
| Type | Wrapper | Description |
| Facet | fromDataModel | |
| AdditionalFacetView* | - | |
| AggregationFunction* | - | A numerical computation to perform on hits matching each value of the facet. |
| Range* | - |
| Name | Type | Default value | Description |
| min (UI: Min) |
nullabledouble | - | The lower bound of the range (null means minus infinity). |
| max (UI: Max) |
nullabledouble | - | The upper bound of the range (null means plus infinity). |
| lsb (UI: Least significant bit) |
int | 0 | Least significant bit of the numerical value to use. Only used for integral types. |
| msb (UI: Most significant bit) |
int | 63 | Most significant bit of the numerical value to use. Only used for integral types. |
| title | string | - |
| Name | Type | Default value | Description |
| expr (UI: Expression) |
string | - | Virtual field expression for this facet. |
| min (UI: Exclude values below) |
nullabledouble | - | Excludes values below this threshold from the facet. |
| max (UI: Exclude values above) |
nullabledouble | - | Excludes values above this threshold from the facet. |
| lsb (UI: Least significant bit) |
int | 0 | Least significant bit of the numerical value to use. Only used for integral types. |
| msb (UI: Most significant bit) |
int | 63 | Most significant bit of the numerical value to use. Only used for integral types. |
| maxValues (UI: Max. categories) |
int | 100 | Maximum number of displayed values. |
| defaultPrecision (UI: Default precision) |
int | 0 | Default precision, in number of trailing digits, for float-typed expressions with double precision (e.g. "#random()"). For example, if defaultPrecision is 2, 0.011 and 0.012 will be considered similar, and categories will be displayed with two significant digits (e.g. [0.00;0.99]) |
| virtualRoot (UI: Virtual root) |
string | - | Path for the resulting root 'virtual' category. When using a virtual facet (a facet which is not stored in a category field), all created categories are attached to a virtual root path. For example: Top/VirtualRoot/[0;5] |
| id | string | - | Unique identifier of this facet. Used in Mashup-Builder and client applications to identify the facet. |
| type | enum(category, h2d, num_explicit, num_fixed, num_dynamic, geo, autotile, value, multi, enum, date, dyndate, autotilev2, concatvalue) | Used for convenience in various introspection code | |
| refinementPolicy (UI: Refinement policy) |
enum(exclusive, disjunctive, norefine) | exclusive | Defines the Refinements panel behavior.
|
| implementation (UI: Implementation) |
enum(autodetect, favor_cpu, favor_memory) | autodetect | Internal algorithm for implementation of this facet. Value can be null or one of
|
| inNavigation (UI: Use for navigation) |
boolean | True | Computes navigation on this facet. |
| inHits (UI: Use for hit content) |
boolean | True | Computes the value of this facet for each hit. |
| maxSliceCategories (UI: Max categories per slices) |
int | 0 | Maximum number of categories returned by each slice for one facet. 0 means no limit. Warning: Results merged by the search server may be incorrect. |
| sortFunction (UI: Sort by) |
enum(count, relevancy, alphanum, num, range, date, aggregation, explicit, lat, lng) | count | Specifies a sorting function:
|
| aggregateScores (UI: Aggregate scores) |
boolean | False | If selected, the category score will be the sum of the scores of all its hits. |
| rangeSize (UI: Range size) |
double | 0.0 | Size of each range. 0 means that the resulting facet will contain one range for each unique value. |
| aboveMax (UI: Above max range) |
boolean | False | Creates a range [max;] that includes all values above the max. |
| belowMin (UI: Below min range) |
boolean | False | Creates a range [;min] that includes all values below the min. |
| rangeTitleFormat (UI: Range title format) |
string | [$;$] | Format for the generated range titles. The first dollar sign will be replaced with the range's lower bound, and the second dollar sign will be replaced with the range's upper bound. To write a dollar sign, use \$. |
| aboveTitleFormat (UI: Above max range title format) |
string | [$;] | Format for the generated "above max" range. The dollar sign will be replaced with the range's lower bound. To write a dollar sign, use \$. |
| belowTitleFormat (UI: Below min range title format) |
string | [;$] | Format for the generated "below min" range. The dollar sign will be replaced with the range's upper bound. To write a dollar sign, use \$. |
| singletonTitleFormat (UI: Singleton range title format) |
string | $ | Format for the generated single value range titles (like [3;3]). The dollar sign will be replaced with the value. To write a dollar sign, use \$. |
| minDocsPerCategory (UI: Min. docs per category) |
int | 1 | Minimum number of docs in a category for it to be included in the Refinements panel. |
| maxCategories (UI: Max. categories) |
int | 0 | Maximum number of categories to display in the facet. 0 means all categories will be displayed. |
| maxCategoriesPerLevel (UI: Max. categories per level) |
int | 100 | Maximum number of facet values in each level of the categories hierarchy. 0 means that all values are selected. The sortFunction is used to select the "best" facet values for each level. |
| sortAggregationFunction (UI: Aggregation function) |
string | - | Aggregation function used to sort by aggregation values. |
| explicitSortOrderValues (UI: Explicit order) |
string | - | Ordered list of values used for explicit sort, comma-separated (use the backslash to escape a comma). |
| reverse (UI: Reverse) |
boolean | False | Reverse sorting order. |
| index | int | - | Internal. |
| dataModelState | string | - | |
| dataModelClass | string | - | If dataModelState is "auto" or "customized", you will find here the name of the DataModelClass that generated this facet. |
| dataModelProperty | string | - | If dataModelState is "auto" or "customized", you will find here the name of the DataModelProperty that generated this facet. |
| Type | Wrapper | Description |
| Facet | fromDataModel | |
| AdditionalFacetView* | - | |
| AggregationFunction* | - | A numerical computation to perform on hits matching each value of the facet. |
| Name | Type | Default value | Description |
| expr (UI: Expression) |
string | - | Virtual field expression for this facet. |
| min (UI: Exclude values below) |
nullabledouble | - | Excludes values below this threshold from the facet. |
| max (UI: Exclude values above) |
nullabledouble | - | Excludes values above this threshold from the facet. |
| lsb (UI: Least significant bit) |
int | 0 | Least significant bit of the numerical value to use. Only used for integral types. |
| msb (UI: Most significant bit) |
int | 63 | Most significant bit of the numerical value to use. Only used for integral types. |
| maxValues (UI: Max. categories) |
int | 100 | Maximum number of displayed values. |
| defaultPrecision (UI: Default precision) |
int | 0 | Default precision, in number of trailing digits, for float-typed expressions with double precision (e.g. "#random()"). For example, if defaultPrecision is 2, 0.011 and 0.012 will be considered similar, and categories will be displayed with two significant digits (e.g. [0.00;0.99]) |
| virtualRoot (UI: Virtual root) |
string | - | Path for the resulting root 'virtual' category. When using a virtual facet (a facet which is not stored in a category field), all created categories are attached to a virtual root path. For example: Top/VirtualRoot/[0;5] |
| id | string | - | Unique identifier of this facet. Used in Mashup-Builder and client applications to identify the facet. |
| type | enum(category, h2d, num_explicit, num_fixed, num_dynamic, geo, autotile, value, multi, enum, date, dyndate, autotilev2, concatvalue) | Used for convenience in various introspection code | |
| refinementPolicy (UI: Refinement policy) |
enum(exclusive, disjunctive, norefine) | exclusive | Defines the Refinements panel behavior.
|
| implementation (UI: Implementation) |
enum(autodetect, favor_cpu, favor_memory) | autodetect | Internal algorithm for implementation of this facet. Value can be null or one of
|
| inNavigation (UI: Use for navigation) |
boolean | True | Computes navigation on this facet. |
| inHits (UI: Use for hit content) |
boolean | True | Computes the value of this facet for each hit. |
| maxSliceCategories (UI: Max categories per slices) |
int | 0 | Maximum number of categories returned by each slice for one facet. 0 means no limit. Warning: Results merged by the search server may be incorrect. |
| sortFunction (UI: Sort by) |
enum(count, relevancy, alphanum, num, range, date, aggregation, explicit, lat, lng) | count | Specifies a sorting function:
|
| aggregateScores (UI: Aggregate scores) |
boolean | False | If selected, the category score will be the sum of the scores of all its hits. |
| minimumRangeSize | double | 1.0 | Size of each bin used to compute cardinality. |
| nbRanges | int | 5 | The maximal number of ranges to output. |
| policy | enum(linear, geometrical, auto) | linear | The policy to generate the ranges Value can be null or one of
|
| adjustRanges | boolean | True | Tries to adjust the ranges on multiples of 10. |
| moreAccurate | boolean | False | Better linear/geometrical ranges, but slower. |
| rangeTitleFormat | string | [$;$] | Format for the generated range titles. The first dollar sign will be replaced with the range's lower bound, and the second dollar sign will be replaced with the range's upper bound. To write a dollar sign, use \$. |
| exclusiveRightBracket (UI: Exclusive right bracket [a;b[) |
boolean | False | If exclusiveRightBracket is set to true then the facet will be represented by an open range [a,b[, that means it will not contain hits with value equal to b. otherwise the facet will be in inclusive mode [a,b]. |
| minDocsPerCategory (UI: Min. docs per category) |
int | 1 | Minimum number of docs in a category for it to be included in the Refinements panel. |
| maxCategories (UI: Max. categories) |
int | 0 | Maximum number of categories to display in the facet. 0 means all categories will be displayed. |
| maxCategoriesPerLevel (UI: Max. categories per level) |
int | 100 | Maximum number of facet values in each level of the categories hierarchy. 0 means that all values are selected. The sortFunction is used to select the "best" facet values for each level. |
| sortAggregationFunction (UI: Aggregation function) |
string | - | Aggregation function used to sort by aggregation values. |
| explicitSortOrderValues (UI: Explicit order) |
string | - | Ordered list of values used for explicit sort, comma-separated (use the backslash to escape a comma). |
| reverse (UI: Reverse) |
boolean | False | Reverse sorting order. |
| index | int | - | Internal. |
| dataModelState | string | - | |
| dataModelClass | string | - | If dataModelState is "auto" or "customized", you will find here the name of the DataModelClass that generated this facet. |
| dataModelProperty | string | - | If dataModelState is "auto" or "customized", you will find here the name of the DataModelProperty that generated this facet. |
| Type | Wrapper | Description |
| Facet | fromDataModel | |
| AdditionalFacetView* | - | |
| AggregationFunction* | - | A numerical computation to perform on hits matching each value of the facet. |
| Name | Type | Default value | Description |
| virtualRoot (UI: Virtual root) |
string | - | Path for the resulting root 'virtual' category. When using a virtual facet (a facet which is not stored in a category field), all created categories are attached to a virtual root path. For example: Top/VirtualRoot/[0;5] |
| id | string | - | Unique identifier of this facet. Used in Mashup-Builder and client applications to identify the facet. |
| type | enum(category, h2d, num_explicit, num_fixed, num_dynamic, geo, autotile, value, multi, enum, date, dyndate, autotilev2, concatvalue) | Used for convenience in various introspection code | |
| refinementPolicy (UI: Refinement policy) |
enum(exclusive, disjunctive, norefine) | exclusive | Defines the Refinements panel behavior.
|
| implementation (UI: Implementation) |
enum(autodetect, favor_cpu, favor_memory) | autodetect | Internal algorithm for implementation of this facet. Value can be null or one of
|
| inNavigation (UI: Use for navigation) |
boolean | True | Computes navigation on this facet. |
| inHits (UI: Use for hit content) |
boolean | True | Computes the value of this facet for each hit. |
| maxSliceCategories (UI: Max categories per slices) |
int | 0 | Maximum number of categories returned by each slice for one facet. 0 means no limit. Warning: Results merged by the search server may be incorrect. |
| sortFunction (UI: Sort by) |
enum(count, relevancy, alphanum, num, range, date, aggregation, explicit, lat, lng) | count | Specifies a sorting function:
|
| aggregateScores (UI: Aggregate scores) |
boolean | False | If selected, the category score will be the sum of the scores of all its hits. |
| field | string | - | The point field on which to perform the synthesis. |
| hitsMaxCategories | int | 100 | Maximum number of categories displayed in hits. |
| useGeometryAsDomainId | boolean | True | The domain id will be computed with the geometric parameters. Otherwise, an unique id will be used. (recommanded value: false, except for backward compatibility) |
| minDocsPerCategory (UI: Min. docs per category) |
int | 1 | Minimum number of docs in a category for it to be included in the Refinements panel. |
| maxCategories (UI: Max. categories) |
int | 0 | Maximum number of categories to display in the facet. 0 means all categories will be displayed. |
| maxCategoriesPerLevel (UI: Max. categories per level) |
int | 100 | Maximum number of facet values in each level of the categories hierarchy. 0 means that all values are selected. The sortFunction is used to select the "best" facet values for each level. |
| sortAggregationFunction (UI: Aggregation function) |
string | - | Aggregation function used to sort by aggregation values. |
| explicitSortOrderValues (UI: Explicit order) |
string | - | Ordered list of values used for explicit sort, comma-separated (use the backslash to escape a comma). |
| reverse (UI: Reverse) |
boolean | False | Reverse sorting order. |
| index | int | - | Internal. |
| dataModelState | string | - | |
| dataModelClass | string | - | If dataModelState is "auto" or "customized", you will find here the name of the DataModelClass that generated this facet. |
| dataModelProperty | string | - | If dataModelState is "auto" or "customized", you will find here the name of the DataModelProperty that generated this facet. |
| Type | Wrapper | Description |
| Facet | fromDataModel | |
| AdditionalFacetView* | - | |
| AggregationFunction* | - | A numerical computation to perform on hits matching each value of the facet. |
| GeoDomain* | - | List of GeoDomains |
| Name | Type | Default value | Description |
| virtualRoot (UI: Virtual root) |
string | - | Path for the resulting root 'virtual' category. When using a virtual facet (a facet which is not stored in a category field), all created categories are attached to a virtual root path. For example: Top/VirtualRoot/[0;5] |
| id | string | - | Unique identifier of this facet. Used in Mashup-Builder and client applications to identify the facet. |
| type | enum(category, h2d, num_explicit, num_fixed, num_dynamic, geo, autotile, value, multi, enum, date, dyndate, autotilev2, concatvalue) | Used for convenience in various introspection code | |
| refinementPolicy (UI: Refinement policy) |
enum(exclusive, disjunctive, norefine) | exclusive | Defines the Refinements panel behavior.
|
| implementation (UI: Implementation) |
enum(autodetect, favor_cpu, favor_memory) | autodetect | Internal algorithm for implementation of this facet. Value can be null or one of
|
| inNavigation (UI: Use for navigation) |
boolean | True | Computes navigation on this facet. |
| inHits (UI: Use for hit content) |
boolean | True | Computes the value of this facet for each hit. |
| maxSliceCategories (UI: Max categories per slices) |
int | 0 | Maximum number of categories returned by each slice for one facet. 0 means no limit. Warning: Results merged by the search server may be incorrect. |
| sortFunction (UI: Sort by) |
enum(count, relevancy, alphanum, num, range, date, aggregation, explicit, lat, lng) | count | Specifies a sorting function:
|
| aggregateScores (UI: Aggregate scores) |
boolean | False | If selected, the category score will be the sum of the scores of all its hits. |
| field | string | - | The point field on which to perform the synthesis. |
| xMin | double | -90 | Minimum bounding box X value. |
| yMin | double | -180 | Minimum bounding box Y value. |
| xMax | double | 90 | Maximum bounding box X value. |
| yMax | double | 180 | Maximum bounding box Y value. |
| xBinSize | double | 0.1 | Size of a tile in the X direction. |
| yBinSize | double | 0.1 | Size of a tile in the Y direction. |
| minDocsPerCategory (UI: Min. docs per category) |
int | 1 | Minimum number of docs in a category for it to be included in the Refinements panel. |
| maxCategories (UI: Max. categories) |
int | 0 | Maximum number of categories to display in the facet. 0 means all categories will be displayed. |
| maxCategoriesPerLevel (UI: Max. categories per level) |
int | 100 | Maximum number of facet values in each level of the categories hierarchy. 0 means that all values are selected. The sortFunction is used to select the "best" facet values for each level. |
| sortAggregationFunction (UI: Aggregation function) |
string | - | Aggregation function used to sort by aggregation values. |
| explicitSortOrderValues (UI: Explicit order) |
string | - | Ordered list of values used for explicit sort, comma-separated (use the backslash to escape a comma). |
| reverse (UI: Reverse) |
boolean | False | Reverse sorting order. |
| index | int | - | Internal. |
| dataModelState | string | - | |
| dataModelClass | string | - | If dataModelState is "auto" or "customized", you will find here the name of the DataModelClass that generated this facet. |
| dataModelProperty | string | - | If dataModelState is "auto" or "customized", you will find here the name of the DataModelProperty that generated this facet. |
| Type | Wrapper | Description |
| Facet | fromDataModel | |
| AdditionalFacetView* | - | |
| AggregationFunction* | - | A numerical computation to perform on hits matching each value of the facet. |
| Name | Type | Default value | Description |
| virtualRoot (UI: Virtual root) |
string | - | Path for the resulting root 'virtual' category. When using a virtual facet (a facet which is not stored in a category field), all created categories are attached to a virtual root path. For example: Top/VirtualRoot/[0;5] |
| id | string | - | Unique identifier of this facet. Used in Mashup-Builder and client applications to identify the facet. |
| type | enum(category, h2d, num_explicit, num_fixed, num_dynamic, geo, autotile, value, multi, enum, date, dyndate, autotilev2, concatvalue) | Used for convenience in various introspection code | |
| refinementPolicy (UI: Refinement policy) |
enum(exclusive, disjunctive, norefine) | exclusive | Defines the Refinements panel behavior.
|
| implementation (UI: Implementation) |
enum(autodetect, favor_cpu, favor_memory) | autodetect | Internal algorithm for implementation of this facet. Value can be null or one of
|
| inNavigation (UI: Use for navigation) |
boolean | True | Computes navigation on this facet. |
| inHits (UI: Use for hit content) |
boolean | True | Computes the value of this facet for each hit. |
| maxSliceCategories (UI: Max categories per slices) |
int | 0 | Maximum number of categories returned by each slice for one facet. 0 means no limit. Warning: Results merged by the search server may be incorrect. |
| sortFunction (UI: Sort by) |
enum(count, relevancy, alphanum, num, range, date, aggregation, explicit, lat, lng) | count | Specifies a sorting function:
|
| aggregateScores (UI: Aggregate scores) |
boolean | False | If selected, the category score will be the sum of the scores of all its hits. |
| field | string | - | The geov2 field on which to perform the synthesis. |
| xMin | double | -90 | Minimum bounding box X value. |
| yMin | double | -180 | Minimum bounding box Y value. |
| xMax | double | 90 | Maximum bounding box X value. |
| yMax | double | 180 | Maximum bounding box Y value. |
| xNbCells | int | 10 | Number of tiles in the X direction. |
| yNbCells | int | 10 | Number of tiles in the Y direction. |
| hitsMaxCategories | int | 100 | Maximum number of categories displayed in hits. |
| minDocsPerCategory (UI: Min. docs per category) |
int | 1 | Minimum number of docs in a category for it to be included in the Refinements panel. |
| maxCategories (UI: Max. categories) |
int | 0 | Maximum number of categories to display in the facet. 0 means all categories will be displayed. |
| maxCategoriesPerLevel (UI: Max. categories per level) |
int | 100 | Maximum number of facet values in each level of the categories hierarchy. 0 means that all values are selected. The sortFunction is used to select the "best" facet values for each level. |
| sortAggregationFunction (UI: Aggregation function) |
string | - | Aggregation function used to sort by aggregation values. |
| explicitSortOrderValues (UI: Explicit order) |
string | - | Ordered list of values used for explicit sort, comma-separated (use the backslash to escape a comma). |
| reverse (UI: Reverse) |
boolean | False | Reverse sorting order. |
| index | int | - | Internal. |
| dataModelState | string | - | |
| dataModelClass | string | - | If dataModelState is "auto" or "customized", you will find here the name of the DataModelClass that generated this facet. |
| dataModelProperty | string | - | If dataModelState is "auto" or "customized", you will find here the name of the DataModelProperty that generated this facet. |
| Type | Wrapper | Description |
| Facet | fromDataModel | |
| AdditionalFacetView* | - | |
| AggregationFunction* | - | A numerical computation to perform on hits matching each value of the facet. |
| Name | Type | Default value | Description |
| virtualRoot (UI: Virtual root) |
string | - | Path for the resulting root 'virtual' category. When using a virtual facet (a facet which is not stored in a category field), all created categories are attached to a virtual root path. For example: Top/VirtualRoot/[0;5] |
| id | string | - | Unique identifier of this facet. Used in Mashup-Builder and client applications to identify the facet. |
| type | enum(category, h2d, num_explicit, num_fixed, num_dynamic, geo, autotile, value, multi, enum, date, dyndate, autotilev2, concatvalue) | Used for convenience in various introspection code | |
| refinementPolicy (UI: Refinement policy) |
enum(exclusive, disjunctive, norefine) | exclusive | Defines the Refinements panel behavior.
|
| implementation (UI: Implementation) |
enum(autodetect, favor_cpu, favor_memory) | autodetect | Internal algorithm for implementation of this facet. Value can be null or one of
|
| inNavigation (UI: Use for navigation) |
boolean | True | Computes navigation on this facet. |
| inHits (UI: Use for hit content) |
boolean | True | Computes the value of this facet for each hit. |
| maxSliceCategories (UI: Max categories per slices) |
int | 0 | Maximum number of categories returned by each slice for one facet. 0 means no limit. Warning: Results merged by the search server may be incorrect. |
| sortFunction (UI: Sort by) |
enum(count, relevancy, alphanum, num, range, date, aggregation, explicit, lat, lng) | count | Specifies a sorting function:
|
| aggregateScores (UI: Aggregate scores) |
boolean | False | If selected, the category score will be the sum of the scores of all its hits. |
| expr | string | - | The date field or virtual expr to use. |
| yearOutputFormat | string | %Y | The output format used to generate year-based categories. |
| quarterOutputFormat | string | %Y %Q | The output format used to generate quarter-based categories (use %Q to specify the quarter number). |
| monthOutputFormat | string | %b %Y | The output format used to generate month-based categories. |
| weekOutputFormat | string | week %V %Y | The output format used to generate week-based categories. |
| dayOutputFormat | string | %Y/%m/%d | The output format used to generate day-based categories. |
| hourOutputFormat | string | %Y/%m/%d %H | The output format used to generate hour-based categories. |
| minuteOutputFormat | string | %Y/%m/%d %H:%M | The output format used to generate minute-based categories. |
| secondOutputFormat | string | %Y/%m/%d %H:%M:%S | The output format used to generate second-based categories. |
| enableYearLevel | boolean | True | Enables the year level |
| enableQuarterLevel | boolean | False | Enables the quarter level |
| enableMonthLevel | boolean | True | Enables the month level |
| enableWeekLevel | boolean | False | Enables the week level |
| enableDayLevel | boolean | True | Enables the day level |
| enableHourLevel | boolean | False | Enables the hour level |
| enableMinuteLevel | boolean | False | Enables the minute level |
| enableSecondLevel | boolean | False | Enables the second level |
| enableISO8601Compliance | boolean | True | Enables the ISO 8601 standard instead of the American standard. In ISO 8601, weeks start on Monday and a few rules determine the first and last weeks of each year. Use compatible Output formats. Typically, use %V for ISO 8601 instead of %U for American, otherwise week numbering will not be consistent with grouping. |
| generateMissingIntervals | boolean | True | Generates missing dates setting their count to 0 and aggregation values to NO_VALUE |
| minDocsPerCategory (UI: Min. docs per category) |
int | 1 | Minimum number of docs in a category for it to be included in the Refinements panel. |
| maxCategories (UI: Max. categories) |
int | 0 | Maximum number of categories to display in the facet. 0 means all categories will be displayed. |
| maxCategoriesPerLevel (UI: Max. categories per level) |
int | 100 | Maximum number of facet values in each level of the categories hierarchy. 0 means that all values are selected. The sortFunction is used to select the "best" facet values for each level. |
| sortAggregationFunction (UI: Aggregation function) |
string | - | Aggregation function used to sort by aggregation values. |
| explicitSortOrderValues (UI: Explicit order) |
string | - | Ordered list of values used for explicit sort, comma-separated (use the backslash to escape a comma). |
| reverse (UI: Reverse) |
boolean | False | Reverse sorting order. |
| index | int | - | Internal. |
| dataModelState | string | - | |
| dataModelClass | string | - | If dataModelState is "auto" or "customized", you will find here the name of the DataModelClass that generated this facet. |
| dataModelProperty | string | - | If dataModelState is "auto" or "customized", you will find here the name of the DataModelProperty that generated this facet. |
| Type | Wrapper | Description |
| Facet | fromDataModel | |
| AdditionalFacetView* | - | |
| AggregationFunction* | - | A numerical computation to perform on hits matching each value of the facet. |
| Name | Type | Default value | Description |
| virtualRoot (UI: Virtual root) |
string | - | Path for the resulting root 'virtual' category. When using a virtual facet (a facet which is not stored in a category field), all created categories are attached to a virtual root path. For example: Top/VirtualRoot/[0;5] |
| id | string | - | Unique identifier of this facet. Used in Mashup-Builder and client applications to identify the facet. |
| type | enum(category, h2d, num_explicit, num_fixed, num_dynamic, geo, autotile, value, multi, enum, date, dyndate, autotilev2, concatvalue) | Used for convenience in various introspection code | |
| refinementPolicy (UI: Refinement policy) |
enum(exclusive, disjunctive, norefine) | exclusive | Defines the Refinements panel behavior.
|
| implementation (UI: Implementation) |
enum(autodetect, favor_cpu, favor_memory) | autodetect | Internal algorithm for implementation of this facet. Value can be null or one of
|
| inNavigation (UI: Use for navigation) |
boolean | True | Computes navigation on this facet. |
| inHits (UI: Use for hit content) |
boolean | True | Computes the value of this facet for each hit. |
| maxSliceCategories (UI: Max categories per slices) |
int | 0 | Maximum number of categories returned by each slice for one facet. 0 means no limit. Warning: Results merged by the search server may be incorrect. |
| sortFunction (UI: Sort by) |
enum(count, relevancy, alphanum, num, range, date, aggregation, explicit, lat, lng) | count | Specifies a sorting function:
|
| aggregateScores (UI: Aggregate scores) |
boolean | False | If selected, the category score will be the sum of the scores of all its hits. |
| expr | string | - | The date field or virtual expr on which the synthesis must be performed. |
| startExpr | string | #datetime(0) | A CONSTANT virtual expression that evaluates the time when the synthesis starts (e.g. #now(), #fromunixts(1304865423) or #datetime(1983,2,28)). |
| endExpr | string | #datetime(10000) | A CONSTANT virtual expression that evaluates the time when the synthesis ends. |
| beforeStart | boolean | False | Creates a virtual category for all dates before the start. |
| afterEnd | boolean | False | Creates a virtual category for all dates after the end. |
| withYear | boolean | True | Creates a virtual category for each year. |
| yearDesc | boolean | True | |
| withMonth | boolean | True | Creates a virtual category for each month. |
| monthDesc | boolean | False | |
| withWeek | boolean | False | Creates a virtual category for each week. |
| weekDesc | boolean | False | |
| withDay | boolean | True | Creates a virtual category for each day. |
| dayDesc | boolean | False | |
| withHour | boolean | False | Creates a virtual category for each hour. |
| hourDesc | boolean | False | |
| withMinute | boolean | False | Creates a virtual category for each minute. |
| minuteDesc | boolean | False | |
| withSecond | boolean | False | Creates a virtual category for each second. |
| secondDesc | boolean | False | |
| useAsFirstLevel | int | 0 | Used internally by multidim refinements to tell which level is the first level below root. |
| maxCategoryTreeDepth (UI: Max. tree depth from current refinement) |
int | 0 | Maximum depth of the returned category tree. Whatever the level of refinement, there will never be more levels retrieved (this ensures we are not overtaking the maxCategoryTreeDepthFromRoot). |
| maxCategoryTreeDepthFromRoot (UI: Max. tree depth from root) |
int | 0 | Maximum depth of the returned category tree, starting from the global root of the category. Setting this attribute to N means that no categories will be kept below this level. |
| minDocsPerCategory (UI: Min. docs per category) |
int | 1 | Minimum number of docs in a category for it to be included in the Refinements panel. |
| maxCategories (UI: Max. categories) |
int | 0 | Maximum number of categories to display in the facet. 0 means all categories will be displayed. |
| maxCategoriesPerLevel (UI: Max. categories per level) |
int | 100 | Maximum number of facet values in each level of the categories hierarchy. 0 means that all values are selected. The sortFunction is used to select the "best" facet values for each level. |
| sortAggregationFunction (UI: Aggregation function) |
string | - | Aggregation function used to sort by aggregation values. |
| explicitSortOrderValues (UI: Explicit order) |
string | - | Ordered list of values used for explicit sort, comma-separated (use the backslash to escape a comma). |
| reverse (UI: Reverse) |
boolean | False | Reverse sorting order. |
| index | int | - | Internal. |
| dataModelState | string | - | |
| dataModelClass | string | - | If dataModelState is "auto" or "customized", you will find here the name of the DataModelClass that generated this facet. |
| dataModelProperty | string | - | If dataModelState is "auto" or "customized", you will find here the name of the DataModelProperty that generated this facet. |
| Type | Wrapper | Description |
| Facet | fromDataModel | |
| AdditionalFacetView* | - | |
| AggregationFunction* | - | A numerical computation to perform on hits matching each value of the facet. |
| Name | Type | Default value | Description |
| virtualRoot (UI: Virtual root) |
string | - | Path for the resulting root 'virtual' category. When using a virtual facet (a facet which is not stored in a category field), all created categories are attached to a virtual root path. For example: Top/VirtualRoot/[0;5] |
| id | string | - | Unique identifier of this facet. Used in Mashup-Builder and client applications to identify the facet. |
| type | enum(category, h2d, num_explicit, num_fixed, num_dynamic, geo, autotile, value, multi, enum, date, dyndate, autotilev2, concatvalue) | Used for convenience in various introspection code | |
| refinementPolicy (UI: Refinement policy) |
enum(exclusive, disjunctive, norefine) | exclusive | Defines the Refinements panel behavior.
|
| implementation (UI: Implementation) |
enum(autodetect, favor_cpu, favor_memory) | autodetect | Internal algorithm for implementation of this facet. Value can be null or one of
|
| inNavigation (UI: Use for navigation) |
boolean | True | Computes navigation on this facet. |
| inHits (UI: Use for hit content) |
boolean | True | Computes the value of this facet for each hit. |
| maxSliceCategories (UI: Max categories per slices) |
int | 0 | Maximum number of categories returned by each slice for one facet. 0 means no limit. Warning: Results merged by the search server may be incorrect. |
| sortFunction (UI: Sort by) |
enum(count, relevancy, alphanum, num, range, date, aggregation, explicit, lat, lng) | count | Specifies a sorting function:
|
| aggregateScores (UI: Aggregate scores) |
boolean | False | If selected, the category score will be the sum of the scores of all its hits. |
| field | string | - | The Value field on which to perform the synthesis. |
| hitsMaxCategories | int | 100 | Maximum number of categories displayed in hits. |
| minDocsPerCategory (UI: Min. docs per category) |
int | 1 | Minimum number of docs in a category for it to be included in the Refinements panel. |
| maxCategories (UI: Max. categories) |
int | 0 | Maximum number of categories to display in the facet. 0 means all categories will be displayed. |
| maxCategoriesPerLevel (UI: Max. categories per level) |
int | 100 | Maximum number of facet values in each level of the categories hierarchy. 0 means that all values are selected. The sortFunction is used to select the "best" facet values for each level. |
| sortAggregationFunction (UI: Aggregation function) |
string | - | Aggregation function used to sort by aggregation values. |
| explicitSortOrderValues (UI: Explicit order) |
string | - | Ordered list of values used for explicit sort, comma-separated (use the backslash to escape a comma). |
| reverse (UI: Reverse) |
boolean | False | Reverse sorting order. |
| index | int | - | Internal. |
| dataModelState | string | - | |
| dataModelClass | string | - | If dataModelState is "auto" or "customized", you will find here the name of the DataModelClass that generated this facet. |
| dataModelProperty | string | - | If dataModelState is "auto" or "customized", you will find here the name of the DataModelProperty that generated this facet. |
| Type | Wrapper | Description |
| Facet | fromDataModel | |
| AdditionalFacetView* | - | |
| AggregationFunction* | - | A numerical computation to perform on hits matching each value of the facet. |
| Name | Type | Default value | Description |
| field | string | - | The Value field on which to perform the synthesis. |
| hitsMaxCategories | int | 100 | Maximum number of categories displayed in hits. |
| virtualRoot (UI: Virtual root) |
string | - | Path for the resulting root 'virtual' category. When using a virtual facet (a facet which is not stored in a category field), all created categories are attached to a virtual root path. For example: Top/VirtualRoot/[0;5] |
| id | string | - | Unique identifier of this facet. Used in Mashup-Builder and client applications to identify the facet. |
| type | enum(category, h2d, num_explicit, num_fixed, num_dynamic, geo, autotile, value, multi, enum, date, dyndate, autotilev2, concatvalue) | Used for convenience in various introspection code | |
| refinementPolicy (UI: Refinement policy) |
enum(exclusive, disjunctive, norefine) | exclusive | Defines the Refinements panel behavior.
|
| implementation (UI: Implementation) |
enum(autodetect, favor_cpu, favor_memory) | autodetect | Internal algorithm for implementation of this facet. Value can be null or one of
|
| inNavigation (UI: Use for navigation) |
boolean | True | Computes navigation on this facet. |
| inHits (UI: Use for hit content) |
boolean | True | Computes the value of this facet for each hit. |
| maxSliceCategories (UI: Max categories per slices) |
int | 0 | Maximum number of categories returned by each slice for one facet. 0 means no limit. Warning: Results merged by the search server may be incorrect. |
| sortFunction (UI: Sort by) |
enum(count, relevancy, alphanum, num, range, date, aggregation, explicit, lat, lng) | count | Specifies a sorting function:
|
| aggregateScores (UI: Aggregate scores) |
boolean | False | If selected, the category score will be the sum of the scores of all its hits. |
| dictionary | string | - | The dictionary containing keywords. |
| minCorpusFrequency | int | 2 | Minimum number of occurrences in the whole index for a term to be possibly selected for synthesis. |
| corpusLowPassFilter | double | 0.5 | Filters out terms occurring more than this threshold in the whole index. |
| localLowPassFilter | double | 0.9 | Filters out terms occurring more than this threshold in the result set. |
| blacklist | string | - | The related-terms blocklist. |
| maxRelatedTermsHitsPerSlice (UI: Max hits per slice) |
int | 5000 | Maximum number of hits per slice used to compute related terms synthesis. Set to 0 for exhaustive. Note that the number of hits processed per slice to compute related terms synthesis will never exceed FacetsConfig's maxHits. |
| minDocsPerCategory (UI: Min. docs per category) |
int | 1 | Minimum number of docs in a category for it to be included in the Refinements panel. |
| maxCategories (UI: Max. categories) |
int | 0 | Maximum number of categories to display in the facet. 0 means all categories will be displayed. |
| maxCategoriesPerLevel (UI: Max. categories per level) |
int | 100 | Maximum number of facet values in each level of the categories hierarchy. 0 means that all values are selected. The sortFunction is used to select the "best" facet values for each level. |
| sortAggregationFunction (UI: Aggregation function) |
string | - | Aggregation function used to sort by aggregation values. |
| explicitSortOrderValues (UI: Explicit order) |
string | - | Ordered list of values used for explicit sort, comma-separated (use the backslash to escape a comma). |
| reverse (UI: Reverse) |
boolean | False | Reverse sorting order. |
| index | int | - | Internal. |
| dataModelState | string | - | |
| dataModelClass | string | - | If dataModelState is "auto" or "customized", you will find here the name of the DataModelClass that generated this facet. |
| dataModelProperty | string | - | If dataModelState is "auto" or "customized", you will find here the name of the DataModelProperty that generated this facet. |
| Type | Wrapper | Description |
| Facet | fromDataModel | |
| AdditionalFacetView* | - | |
| AggregationFunction* | - | A numerical computation to perform on hits matching each value of the facet. |
| Name | Type | Default value | Description |
| virtualRoot (UI: Virtual root) |
string | - | Path for the resulting root 'virtual' category. When using a virtual facet (a facet which is not stored in a category field), all created categories are attached to a virtual root path. For example: Top/VirtualRoot/[0;5] |
| id | string | - | Unique identifier of this facet. Used in Mashup-Builder and client applications to identify the facet. |
| type | enum(category, h2d, num_explicit, num_fixed, num_dynamic, geo, autotile, value, multi, enum, date, dyndate, autotilev2, concatvalue) | Used for convenience in various introspection code | |
| refinementPolicy (UI: Refinement policy) |
enum(exclusive, disjunctive, norefine) | exclusive | Defines the Refinements panel behavior.
|
| implementation (UI: Implementation) |
enum(autodetect, favor_cpu, favor_memory) | autodetect | Internal algorithm for implementation of this facet. Value can be null or one of
|
| inNavigation (UI: Use for navigation) |
boolean | True | Computes navigation on this facet. |
| inHits (UI: Use for hit content) |
boolean | True | Computes the value of this facet for each hit. |
| maxSliceCategories (UI: Max categories per slices) |
int | 0 | Maximum number of categories returned by each slice for one facet. 0 means no limit. Warning: Results merged by the search server may be incorrect. |
| sortFunction (UI: Sort by) |
enum(count, relevancy, alphanum, num, range, date, aggregation, explicit, lat, lng) | count | Specifies a sorting function:
|
| aggregateScores (UI: Aggregate scores) |
boolean | False | If selected, the category score will be the sum of the scores of all its hits. |
| fieldA | string | - | The Value field on which to perform the synthesis. |
| fieldB | string | - | The Value field on which to perform the synthesis. |
| hitsMaxCategories | int | 100 | Maximum number of categories displayed in hits. |
| minDocsPerCategory (UI: Min. docs per category) |
int | 1 | Minimum number of docs in a category for it to be included in the Refinements panel. |
| maxCategories (UI: Max. categories) |
int | 0 | Maximum number of categories to display in the facet. 0 means all categories will be displayed. |
| maxCategoriesPerLevel (UI: Max. categories per level) |
int | 100 | Maximum number of facet values in each level of the categories hierarchy. 0 means that all values are selected. The sortFunction is used to select the "best" facet values for each level. |
| sortAggregationFunction (UI: Aggregation function) |
string | - | Aggregation function used to sort by aggregation values. |
| explicitSortOrderValues (UI: Explicit order) |
string | - | Ordered list of values used for explicit sort, comma-separated (use the backslash to escape a comma). |
| reverse (UI: Reverse) |
boolean | False | Reverse sorting order. |
| index | int | - | Internal. |
| dataModelState | string | - | |
| dataModelClass | string | - | If dataModelState is "auto" or "customized", you will find here the name of the DataModelClass that generated this facet. |
| dataModelProperty | string | - | If dataModelState is "auto" or "customized", you will find here the name of the DataModelProperty that generated this facet. |
| Type | Wrapper | Description |
| Facet | fromDataModel | |
| AdditionalFacetView* | - | |
| AggregationFunction* | - | A numerical computation to perform on hits matching each value of the facet. |
| Name | Type | Default value | Description |
| virtualRoot (UI: Virtual root) |
string | - | Path for the resulting root 'virtual' category. When using a virtual facet (a facet which is not stored in a category field), all created categories are attached to a virtual root path. For example: Top/VirtualRoot/[0;5] |
| id | string | - | Unique identifier of this facet. Used in Mashup-Builder and client applications to identify the facet. |
| type | enum(category, h2d, num_explicit, num_fixed, num_dynamic, geo, autotile, value, multi, enum, date, dyndate, autotilev2, concatvalue) | Used for convenience in various introspection code | |
| refinementPolicy (UI: Refinement policy) |
enum(exclusive, disjunctive, norefine) | exclusive | Defines the Refinements panel behavior.
|
| implementation (UI: Implementation) |
enum(autodetect, favor_cpu, favor_memory) | autodetect | Internal algorithm for implementation of this facet. Value can be null or one of
|
| inNavigation (UI: Use for navigation) |
boolean | True | Computes navigation on this facet. |
| inHits (UI: Use for hit content) |
boolean | True | Computes the value of this facet for each hit. |
| maxSliceCategories (UI: Max categories per slices) |
int | 0 | Maximum number of categories returned by each slice for one facet. 0 means no limit. Warning: Results merged by the search server may be incorrect. |
| sortFunction (UI: Sort by) |
enum(count, relevancy, alphanum, num, range, date, aggregation, explicit, lat, lng) | count | Specifies a sorting function:
|
| aggregateScores (UI: Aggregate scores) |
boolean | False | If selected, the category score will be the sum of the scores of all its hits. |
| luaCode | string | - | The lua code for the facet. |
| minDocsPerCategory (UI: Min. docs per category) |
int | 1 | Minimum number of docs in a category for it to be included in the Refinements panel. |
| maxCategories (UI: Max. categories) |
int | 0 | Maximum number of categories to display in the facet. 0 means all categories will be displayed. |
| maxCategoriesPerLevel (UI: Max. categories per level) |
int | 100 | Maximum number of facet values in each level of the categories hierarchy. 0 means that all values are selected. The sortFunction is used to select the "best" facet values for each level. |
| sortAggregationFunction (UI: Aggregation function) |
string | - | Aggregation function used to sort by aggregation values. |
| explicitSortOrderValues (UI: Explicit order) |
string | - | Ordered list of values used for explicit sort, comma-separated (use the backslash to escape a comma). |
| reverse (UI: Reverse) |
boolean | False | Reverse sorting order. |
| index | int | - | Internal. |
| dataModelState | string | - | |
| dataModelClass | string | - | If dataModelState is "auto" or "customized", you will find here the name of the DataModelClass that generated this facet. |
| dataModelProperty | string | - | If dataModelState is "auto" or "customized", you will find here the name of the DataModelProperty that generated this facet. |
| Type | Wrapper | Description |
| Facet | fromDataModel | |
| AdditionalFacetView* | - | |
| AggregationFunction* | - | A numerical computation to perform on hits matching each value of the facet. |
| Name | Type | Default value | Description |
| virtualRoot (UI: Virtual root) |
string | - | Path for the resulting root 'virtual' category. When using a virtual facet (a facet which is not stored in a category field), all created categories are attached to a virtual root path. For example: Top/VirtualRoot/[0;5] |
| id | string | - | Unique identifier of this facet. Used in Mashup-Builder and client applications to identify the facet. |
| type | enum(category, h2d, num_explicit, num_fixed, num_dynamic, geo, autotile, value, multi, enum, date, dyndate, autotilev2, concatvalue) | Used for convenience in various introspection code | |
| refinementPolicy (UI: Refinement policy) |
enum(exclusive, disjunctive, norefine) | exclusive | Defines the Refinements panel behavior.
|
| implementation (UI: Implementation) |
enum(autodetect, favor_cpu, favor_memory) | autodetect | Internal algorithm for implementation of this facet. Value can be null or one of
|
| inNavigation (UI: Use for navigation) |
boolean | True | Computes navigation on this facet. |
| inHits (UI: Use for hit content) |
boolean | True | Computes the value of this facet for each hit. |
| maxSliceCategories (UI: Max categories per slices) |
int | 0 | Maximum number of categories returned by each slice for one facet. 0 means no limit. Warning: Results merged by the search server may be incorrect. |
| sortFunction (UI: Sort by) |
enum(count, relevancy, alphanum, num, range, date, aggregation, explicit, lat, lng) | count | Specifies a sorting function:
|
| aggregateScores (UI: Aggregate scores) |
boolean | False | If selected, the category score will be the sum of the scores of all its hits. |
| id1 | string | - | id of the first facet on which to perform the synthesis |
| id2 | string | - | id of the second facet on which to perform the synthesis |
| withDimSwitch | boolean | True | Adds a '__dimension_switch__' virtual category between categories of the first and second dimensions. |
| secondarySortFunction | enum(count, relevancy, alphanum, num, range, date, aggregation, explicit, lat, lng) | count | The function to use to sort on the second dimension (see 'sortFunction' in Facet). |
| secondaryReverse | boolean | False | Reverses the secondary sort (see 'reverse' in Facet). |
| secondarySortAggregationFunction | string | - | The aggregation function used to sort by aggregation values. |
| secondaryExplicitSortOrderValues | string | - | The ordered list of values used to sort, comma-separated (use the backslash to escape a comma) |
| hierarchical2DFacetRepresentation | boolean | True | Enables the use of asHierarchical2DFacet() in search client. |
| minDocsPerCategory (UI: Min. docs per category) |
int | 1 | Minimum number of docs in a category for it to be included in the Refinements panel. |
| maxCategories (UI: Max. categories) |
int | 0 | Maximum number of categories to display in the facet. 0 means all categories will be displayed. |
| maxCategoriesPerLevel (UI: Max. categories per level) |
int | 100 | Maximum number of facet values in each level of the categories hierarchy. 0 means that all values are selected. The sortFunction is used to select the "best" facet values for each level. |
| sortAggregationFunction (UI: Aggregation function) |
string | - | Aggregation function used to sort by aggregation values. |
| explicitSortOrderValues (UI: Explicit order) |
string | - | Ordered list of values used for explicit sort, comma-separated (use the backslash to escape a comma). |
| reverse (UI: Reverse) |
boolean | False | Reverse sorting order. |
| index | int | - | Internal. |
| dataModelState | string | - | |
| dataModelClass | string | - | If dataModelState is "auto" or "customized", you will find here the name of the DataModelClass that generated this facet. |
| dataModelProperty | string | - | If dataModelState is "auto" or "customized", you will find here the name of the DataModelProperty that generated this facet. |
| Type | Wrapper | Description |
| Facet | fromDataModel | |
| AdditionalFacetView* | - | |
| AggregationFunction* | - | A numerical computation to perform on hits matching each value of the facet. |
| Name | Type | Default value | Description |
| id | string | - | Unique identifier of this facet. Used in Mashup-Builder and client applications to identify the facet. |
| type | enum(category, h2d, num_explicit, num_fixed, num_dynamic, geo, autotile, value, multi, enum, date, dyndate, autotilev2, concatvalue) | Used for convenience in various introspection code | |
| refinementPolicy (UI: Refinement policy) |
enum(exclusive, disjunctive, norefine) | exclusive | Defines the Refinements panel behavior.
|
| implementation (UI: Implementation) |
enum(autodetect, favor_cpu, favor_memory) | autodetect | Internal algorithm for implementation of this facet. Value can be null or one of
|
| inNavigation (UI: Use for navigation) |
boolean | True | Computes navigation on this facet. |
| inHits (UI: Use for hit content) |
boolean | True | Computes the value of this facet for each hit. |
| maxSliceCategories (UI: Max categories per slices) |
int | 0 | Maximum number of categories returned by each slice for one facet. 0 means no limit. Warning: Results merged by the search server may be incorrect. |
| sortFunction (UI: Sort by) |
enum(count, relevancy, alphanum, num, range, date, aggregation, explicit, lat, lng) | count | Specifies a sorting function:
|
| aggregateScores (UI: Aggregate scores) |
boolean | False | If selected, the category score will be the sum of the scores of all its hits. |
| virtualRoot | string | - | The root of the resulting 'virtual' category. |
| enumFacetId | string | - | Id of the referred EnumFacet. |
| minDocsPerCategory (UI: Min. docs per category) |
int | 1 | Minimum number of docs in a category for it to be included in the Refinements panel. |
| maxCategories (UI: Max. categories) |
int | 0 | Maximum number of categories to display in the facet. 0 means all categories will be displayed. |
| maxCategoriesPerLevel (UI: Max. categories per level) |
int | 100 | Maximum number of facet values in each level of the categories hierarchy. 0 means that all values are selected. The sortFunction is used to select the "best" facet values for each level. |
| sortAggregationFunction (UI: Aggregation function) |
string | - | Aggregation function used to sort by aggregation values. |
| explicitSortOrderValues (UI: Explicit order) |
string | - | Ordered list of values used for explicit sort, comma-separated (use the backslash to escape a comma). |
| reverse (UI: Reverse) |
boolean | False | Reverse sorting order. |
| index | int | - | Internal. |
| dataModelState | string | - | |
| dataModelClass | string | - | If dataModelState is "auto" or "customized", you will find here the name of the DataModelClass that generated this facet. |
| dataModelProperty | string | - | If dataModelState is "auto" or "customized", you will find here the name of the DataModelProperty that generated this facet. |
| Type | Wrapper | Description |
| Facet | fromDataModel | |
| AdditionalFacetView* | - | |
| AggregationFunction* | - | A numerical computation to perform on hits matching each value of the facet. |
| Name | Type | Default value | Description |
| id | string | - | Unique identifier of this facet. Used in Mashup-Builder and client applications to identify the facet. |
| type | enum(category, h2d, num_explicit, num_fixed, num_dynamic, geo, autotile, value, multi, enum, date, dyndate, autotilev2, concatvalue) | Used for convenience in various introspection code | |
| refinementPolicy (UI: Refinement policy) |
enum(exclusive, disjunctive, norefine) | exclusive | Defines the Refinements panel behavior.
|
| implementation (UI: Implementation) |
enum(autodetect, favor_cpu, favor_memory) | autodetect | Internal algorithm for implementation of this facet. Value can be null or one of
|
| inNavigation (UI: Use for navigation) |
boolean | True | Computes navigation on this facet. |
| inHits (UI: Use for hit content) |
boolean | True | Computes the value of this facet for each hit. |
| maxSliceCategories (UI: Max categories per slices) |
int | 0 | Maximum number of categories returned by each slice for one facet. 0 means no limit. Warning: Results merged by the search server may be incorrect. |
| sortFunction (UI: Sort by) |
enum(count, relevancy, alphanum, num, range, date, aggregation, explicit, lat, lng) | count | Specifies a sorting function:
|
| aggregateScores (UI: Aggregate scores) |
boolean | False | If selected, the category score will be the sum of the scores of all its hits. |
| virtualRoot | string | - | The virtual root used for the tree representation. |
| additionalTreeRepresentation | boolean | False | |
| withAdditionalTreeRepresentationDimSwitch | boolean | False | Adds a '__dimension_switch__' virtual category between each dimension of the tree reprentation. This is required if you're working with hierarhical dimensions. |
| minDocsPerCategory (UI: Min. docs per category) |
int | 1 | Minimum number of docs in a category for it to be included in the Refinements panel. |
| maxCategories (UI: Max. categories) |
int | 0 | Maximum number of categories to display in the facet. 0 means all categories will be displayed. |
| maxCategoriesPerLevel (UI: Max. categories per level) |
int | 100 | Maximum number of facet values in each level of the categories hierarchy. 0 means that all values are selected. The sortFunction is used to select the "best" facet values for each level. |
| sortAggregationFunction (UI: Aggregation function) |
string | - | Aggregation function used to sort by aggregation values. |
| explicitSortOrderValues (UI: Explicit order) |
string | - | Ordered list of values used for explicit sort, comma-separated (use the backslash to escape a comma). |
| reverse (UI: Reverse) |
boolean | False | Reverse sorting order. |
| index | int | - | Internal. |
| dataModelState | string | - | |
| dataModelClass | string | - | If dataModelState is "auto" or "customized", you will find here the name of the DataModelClass that generated this facet. |
| dataModelProperty | string | - | If dataModelState is "auto" or "customized", you will find here the name of the DataModelProperty that generated this facet. |
| Type | Wrapper | Description |
| Facet | fromDataModel | |
| AdditionalFacetView* | - | |
| AggregationFunction* | - | A numerical computation to perform on hits matching each value of the facet. |
| MultiFacetDimension* | - |
| Name | Type | Default value | Description |
| id | string | - | The existing 1d facet id to use for this dimension. |
| sortFunction | enum(count, relevancy, alphanum, num, range, date, aggregation, explicit, lat, lng) | count | The sort function on this dimension (does not apply to other dimensions). |
| reverse | boolean | False | Reverses the sort (see 'reverse' in Facet). |
| sortAggregationFunction | string | - | The aggregation function used to sort by aggregation values. |
| explicitSortOrderValues | string | - | The ordered list of values used to sort, comma-separated (use the backslash to escape a comma). |
| maxCategories | int | 0 | The maximum number of categories after sorting in this dimension. |
| Name | Type | Default value | Description |
| fullHits | int | 10 | Number of full hits to retrieve per page. -1 means unlimited. |
| Type | Wrapper | Description |
| AdvancedPipeline | - | |
| DataModelClassMetaInformation | - | |
| Meta* | - | |
| Metas* | - |
| Type | Wrapper | Description |
| CSVMultiField* | - | |
| HitOperation* | - | |
| MultiContextField* | - | |
| RankingField* | - | |
| RetrievedField* | - |
| Name | Type | Default value | Description |
| indexField | string | - | CSV index field to retrieve. |
| Type | Wrapper | Description |
| KeyValue* | - |
| Name | Type | Default value | Description |
| name | string | - | Name of the meta subject of the operation. Not required when this is inside a 'Meta' tag. |
| minValues | int | 0 | Minimum number of values to select. |
| maxValues | int | 50 | Maximum number of values to select. |
| maxBytesToProcess | int | 131072 | Maximum number of bytes to process in the input text. The remaining bytes are not taken into account for the value selection operation. (0=deactivated) |
| relaxAndNodesPolicy | enum(never, toplevel, always) | never | Relax query AND nodes (handle them as if they were OR nodes). Value can be null or one of
|
| facetIds | string | ||
| extraPrefixHandlers | string | ||
| analysisConfig | string | - | Analysis config in which analysisPipeline is searched for tokenization config and extra semantic processors. |
| analysisPipeline | string | - | Pipeline in analysisConfig searched for tokenization config and extra semantic processors. |
| Name | Type | Default value | Description |
| name | string | - | Name of the meta subject of the operation. Not required when this is inside a 'Meta' tag. |
| minLength | int | 100 | Minimum length of the snippet (in characters). |
| maxLength | int | 150 | Maximum length of the snippet (in characters). |
| maxSentenceSegmentLength | int | 150 | Maximum length of sentence segments in the snippet (in characters). |
| minNbWordsInRelevantSentence | int | 10 | Minimum number of words for a sentence to be considered for snippetization |
| maxSentenceSegments | int | 3 | Maximum number of sentence segments in the snippet. |
| maxBytesToProcess | int | 131072 | Maximum number of bytes to process in the input text. The remaining bytes are not taken into account for the snippet operation. (0=deactivated) |
| removeDuplicateSegments | boolean | False | Remove duplicate segments from the snippet. Using this option with a large number of segments may have a negative impact on performance. |
| maxConsecutiveSeparators | int | 0 | Maximum number of consecutive separators. When there are more than this number of separators, they are replaced with a single space character. |
| splitOnSentences | boolean | True | Don't span over sentence boundaries. |
| highlight | boolean | True | Highlight the snippet's tokens matching the query. |
| minimalPatternHighlight | boolean | False | If true, only highlights the alphanumerical part of the pattern. For example, *foo* will only highlight foo in the word football. |
| relaxAndNodesPolicy | enum(never, toplevel, always) | toplevel | Relax query AND nodes (handle them as if they were OR nodes). Value can be null or one of
|
| ifMeta | string | - | Fallback meta if one of the ifMetasMatch meta matches the query. |
| ifMetasMatch | string | Comma-separated list of metas to test against the user query. If a match is found, the summary is filled with the ifMeta value. |
|
| highlightFacetIds | string | Comma-separated list of facets id for which you want to highlight the values of the refines in the current meta. | |
| highlightExtraPrefixHandlers | string | Comma-separated list of prefix handlers for which you want to highlight the query in the current meta. eg: if highlightExtraPrefixHandlers="spellslike" spellslike:foo will highlight foo and its alternate forms in the current meta |
|
| analysisConfig | string | - | Analysis config in which analysisPipeline is searched for tokenization config and extra semantic processors. |
| analysisPipeline | string | - | Pipeline in analysisConfig searched for tokenization config and extra semantic processors. |
| Name | Type | Default value | Description |
| name | string | - | Name of the meta subject of the operation. Not required when this is inside a 'Meta' tag. |
| outputFormat | string | %Y/%m/%d | Date format |
| Name | Type | Default value | Description |
| name | string | - | Name of the meta subject of the operation. Not required when this is inside a 'Meta' tag. |
| outputFormat | string | %Y/%m/%d %H:%M:%S | Datetime format |
| Name | Type | Default value | Description |
| name | string | - | Name of the meta subject of the operation. Not required when this is inside a 'Meta' tag. |
| outputFormat | string | - | Prints Meta according to this format, controls the output as in C printf. |
| Name | Type | Default value | Description |
| name | string | - | Name of the meta subject of the operation. Not required when this is inside a 'Meta' tag. |
| highlightFacetIds | string | ||
| highlightExtraPrefixHandlers | string | ||
| minNbWordsInRelevantSentence | int | 10 | Minimum number of words for a sentence to be considered for snippetization |
| maxBytesToProcess | int | 131072 | Maximum number of bytes to process in the input text. The remaining bytes are not taken into account for the operation. (0=deactivated) |
| maxConsecutiveSeparators | int | 0 | Maximum number of consecutive separators. When there are more than this number of separators, they are replaced with a single space character. |
| relaxAndNodesPolicy | enum(never, toplevel, always) | toplevel | Relax query AND nodes (handle them as if they were OR nodes). Value can be null or one of
|
| minimalPatternHighlight | boolean | False | If true, only highlights the alphanumerical part of the pattern. For example, *foo* will only highlight foo in the word football. |
| analysisConfig | string | - | Analysis config in which analysisPipeline is searched for tokenization config and extra semantic processors. |
| analysisPipeline | string | - | Pipeline in analysisConfig searched for tokenization config and extra semantic processors. |
| Name | Type | Default value | Description |
| name | string | - | Name of the meta subject of the operation. Not required when this is inside a 'Meta' tag. |
| maxLength | int | 150 | Max character length after which the content will be truncated. |
| strict | boolean | False | Truncates even if a blank character is not met. |
| Name | Type | Default value | Description |
| name | string | - | Name of the meta subject of the operation. Not required when this is inside a 'Meta' tag. |
| classId | string | - | The fully-qualified name of the class performing the operation. |
| Type | Wrapper | Description |
| KeyValue* | - |
| Name | Type | Default value | Description |
| classId | string | - | The fully-qualified name of the class performing the operation. |
| Type | Wrapper | Description |
| KeyValue* | - |
| Name | Type | Default value | Description |
| prefixHandlerName | string | similar | The prefix handler name used in the generated query. |
| metaName | string | similardoc_query | Name of the generated meta containing the resulting query. |
| minNumberOfKeywordPerDoc | long | 4 | Documents with fewer keywords than this constant are ignored. Value must be higher or equal to 0. |
| similarityVirtualField | string | similarity | Name of the virtual field computing the final similarity score. |
| similarityThreshold | double | - | The mininum similarity score for two documents to be considered similar. Value must be between 0 and 1. |
| languageConstraint | boolean | True | Forces similar documents to be in the same language. |
| keywordsMetaName | string | keyword | Name of the retrieved meta containing the keywords. |
| Name | Type | Default value | Description |
| indexField | string | - | Index field or Virtual Expression to retrieve. |
| name | string | - | Name of the meta to create from this field. If not set, the index field name is used. |
| type | string | - | The type of the field to retrieve FIXME |
| contextName | string | - | |
| keepMetaName | boolean | True | When set to true, a key:value stored in the field will create a meta "key" which value is "value". Otherwise, this will generate a meta "name" which value is "value". |
| Type | Wrapper | Description |
| MatchRule* | - | List of rules to define which document metas should be mapped to this dynamic property. |
| Name | Type | Default value | Description |
| pattern | string | - | If null, property name is used |
| mode | enum(prefix, suffix, substring, exact) |
| Name | Type | Default value | Description |
| expr | string | - |
| Name | Type | Default value | Description |
| indexField | string | - | Index field or Virtual Expression to retrieve. |
| name | string | - | Name of the meta to create from this field. If not set, the index field name is used. |
| type | string | - | The type of the field to retrieve FIXME |
| multivalued | boolean | False | Is the field to retrieve multivalued? FIXME |
| dataModelState | string | - | Is this retrieved field managed by a data model?
@enum{null,auto,customized, error}. If null, this retrieved field is not related to a data model. If "auto", this retrieved field is auto-generated by a data model If "customized", this retrieved field was auto-generated by a data model and then customized. If "error", there is a conflict between this retrieved field and the data model. |
| dataModelClass | string | - | If dataModelState is "auto" or "customized", you will find here the name of the DataModelClass that generated this RetrievedField. |
| dataModelProperty | string | - | If dataModelState is "auto" or "customized", you will find here the name of the DataModelProperty that generated this RetrievedField. |
| Type | Wrapper | Description |
| RetrievedField | fromDataModel | If dataModelState is "customized", you will find here the
original retrieved field generated by the data model. Use this to easily revert to "auto" state from "customized". |
| Name | Type | Default value | Description |
| categoryFieldName | string | categories | |
| categoryRoot | string | Top/dataModelClass | |
| categoryForm | enum(exact, lowercase, normalized) | normalized |
| Name | Type | Default value | Description |
| name | string | - | |
| dataModelState | string | - | Is this meta managed by a data model?
@enum{null,auto,customized, error}. If null, this hit category group is not related to a data model. If "auto", this hit category group is auto-generated by a data model If "customized", this hit category group was auto-generated by a data model and then customized. If "error", there is a conflict between this hit category group and the data model |
| dataModelClass | string | - | If dataModelState is "auto" or "customized", you will find here the name of the DataModelClass that generated this meta. |
| dataModelProperty | string | - | If dataModelState is "auto" or "customized", you will find here the name of the DataModelProperty that generated this meta. |
| Type | Wrapper | Description |
| Meta | fromDataModel | |
| MetaSource* | - | |
| MetaSpecificOperation* | - |
| Name | Type | Default value | Description |
| indexField | string | - | Index field, Virtual field or Virtual Expression for this meta source. |
| Name | Type | Default value | Description |
| indexField | string | - | Dynamic index field for this meta source. |
| name | string | - | Specifies the meta name used to retrieve the value in the Dynamic Index Field. If null, it retrieves all meta/value pairs. |
| keepMetaName | boolean | True | When set to true, a key:value stored in the field will create a meta "key" which value is "value". Otherwise, this will generate a meta "name" which value is "value". |
| Type | Wrapper | Description |
| MatchRule* | - | List of rules to define which metas contained in this dynamic field will be processed and displayed. |
| Name | Type | Default value | Description |
| indexField | string | - | CSV-encoded index field for this meta source. |
| metaNameInMultiField | string | - | CSV column name. |
| Type | Wrapper | Description |
| MetasSource* | - |
| Name | Type | Default value | Description |
| indexField | string | - | CSV-encoded index field for this meta source. |
| Name | Type | Default value | Description |
| maxKeptHits | int | - | Number of "best" hits that will be kept for navigation and full hits. It limits the number of hits that can be used for navigation and full hits fetch. Reducing this parameter can slightly increase performance in some situations (many slices, IO-bound). The "nhits" value in answer is at most equal to this limit. 0 means no limit. Note: Heapsort executor is used if this setting is defined in ranked mode. If not in ranked mode, this setting is ignored. |
| maxHitsPerSlice | int | - | Maximum number of hits that a single index slice can fetch. |
| mainHeapFlushInterval | int | - | Unused setting |
| sliceHeapFlushInterval | int | - | Each time the slice heap receives this number of hits, it will be flushed to the main heap. This parameter only impacts performance. If value is 0, the system will pick up an appropriate value. Note: Only used in unranked and heapsort. Not used in localsort. |
| maxQueryTimeMS | int | - | Maximum time spent in the "hits matching" part of the search internal "query" part of the search. After this delay, hits matching is interrupted, partial results will be returned. 0 means no limit. |
| maxFetchedHits | int | - | When this total number of hits matching the query have been found (on any slice), the query is interrupted. These hits are ranked and the "best" ones are selected for navigation and full hits. Reducing this parameter improves performance but it means that a potentially "better" hit located further in the index will not be found. Above this limit, the "nmatches" value in answer will be estimated. 0 means no limit. |
| enoughSlicesPercentage | int | 100 | The query is interrupted if at least this percentage of active slices finished fetching hits. |
| interruptGraceDelayMS | int | 100 | After the query is interrupted, the slices have a small time period to flush their heaps. Hits that arrive to the main heap after this time period are dropped. |
| maxTotalTimeMS | int | - | Maximum time for the entire search (hits matching, navigation and hits computation). After this delay, the search query is aborted. 0 means no limit. |
| fullGraceDelayMS | int | 500 | Additional time after maxTotalTime before forcing the full hits processor to stop. Note that this elapsed time is only checked between two full hits. |
| hitsSampling | double | 100.0 | Only fetch a sample of the matches. This is useful to improve search performance while still getting a good hits distribution. |
| usesConsecutiveQueries | boolean | False | Set this optio to True when you plan to use consecutive queries, then the dedup will occur. |
| maxPathsToConsider | long | 20000000 | If this value is not zero, when doing expand queries without using the "expand=true" mode, the
slices will only consider the first maxExploredPaths paths they find for deciding which DIDs are contained in the graph. |
| needSecuBlockSize | long | 0 | If this value is not zero, when doing attrgraph queries, each document that need to be postfiltered will have its Fullhit rewritten once said number of documents to postfilter has been reached. |
| Type | Wrapper | Description |
| ContentGroupLimitsConfig* | - | Optional specific per content group limits. |
| Name | Type | Default value | Description |
| contentGroup | string | - | Name of the content group. |
| maxHitsPerSlice | int | - | On each slice, when this number of hits matching the query have been found, the query is interrupted. These hits are returned to the searcher, ranked, and the "best" ones are selected for navigation and full hits. Reducing this parameter improves performance but it means that a potentially "better" hit located further in the slice would not be found. If this limit triggers on any slice, the "nmatches" value in answer will be estimated. 0 means no limit. |
| Name | Type | Default value | Description |
| additionalHits | int | - | The number of additional hits to retrieve |
| blacklistUrl | string | - | |
| maxQueryStart | int | 100 |
| Name | Type | Default value | Description |
| blackListURL | string | - | URL to a query-blocklist resource |
| Type | Wrapper | Description |
| NodeRestrictionConfig | - | |
| OperatorRestrictionConfig | - | |
| QueryTermCountRestrictionConfig | - |
| Type | Wrapper | Description |
| RestrictedNode* | - |
| Name | Type | Default value | Description |
| node | enum(AlphanumValue, AlphanumBWPattern, NumericalValue, CategoryValue, TrueNode, FalseNode, NoOp) | ||
| maximumCount | int | -1 | Maximum number of occurences allowed for a given node. |
| action | enum(discard, cleanup) | discard |
| Type | Wrapper | Description |
| OperatorCountRestrictionConfig | - | |
| RestrictedOperator* | - |
| Name | Type | Default value | Description |
| maximumOperatorCount | int | -1 | Maximum number of operators allowed in a query. |
| maximumProximityOperatorCount | int | -1 | Maximum number of proximity operators allowed in a query. The proximity operators are: NEAR NEXT AFTER BEFORE |
| action | enum(discard, cleanup) | discard | Action when maximumOperatorCount is reached: drop query or remove extra operators. The 'cleanup' mode does not guarantee the order in which extra operators are discarded. |
| Name | Type | Default value | Description |
| operator | enum(AND, AT, FUZZYAND, OR, XOR, BOR, NEAR, NOT, NEXT, SEQUENCE, SPLIT, BUTNOT, INNERJOIN, ALL, OPT) | ||
| maximumArity | int | -1 | Maximum number of children allowed for a given operator. |
| action | enum(discard, cleanup, textual) | discard |
| Name | Type | Default value | Description |
| maximumTermCount | int | -1 | Maximum number of alphanumeric tokens allowed in a query. |
| action | enum(discard, cleanup) | discard | Action if maximumTermCount is reached: drop query or cleanup extra values. |
| Name | Type | Default value | Description |
| dictionaryName | string | - | The dictionary containing keywords. |
| enabled | boolean | False | Enables related terms synthesis. |
| number | int | 10 | Maximum number of related terms computed for a query. |
| minCorpusFrequencyFilter | int | 2 | Minimum number of occurrences in the whole index for a term to be possibly selected for synthesis. |
| corpusLowPassFilter | double | 0.5 | Filters out terms occurring more than this threshold in the whole index. |
| optimizedForExhaustiveRankedSynthesis | boolean | False | If true, each slice will sort the DIDs before computing the synthesis to improve attributes fetching locality. |
| sortFunction | enum(count, alphanum) | count | Sort function Value can be one of
|
| localLowPassFilter | double | 0.9 | Filters out terms occurring more than this threshold in the result set. |
| blacklist | string | - | References the related terms blocklist resource. |
| indexField | string | keywordv2 | The index field where related-terms have been indexed. |
| maxSliceCategories (UI: Max categories per slices) |
int | 200 | Maximum number of categories returned by each slice for one facet. 0 means no limit. Warning: Results merged by the search server may be incorrect. |
| maxRelatedTermsHitsPerSlice (UI: Max hits per slice) |
int | 0 | Maximum number of hits per slice used to compute related terms synthesis. Set to 0 for exhaustive. Note that the number of hits processed per slice to compute related terms synthesis will never exceed FacetsConfig's maxHits. |
| Name | Type | Default value | Description |
| enabled | boolean | True | Enables all relevance calculation. Globally disabling relevance calculation disables the following features:
true. </note>
<note>If your query contains a refinement on a disjunctive facet, the relevance feature will be forced to true.</note>In some cases, it provides significant performance boosts, notably for exhaustive counting and faceting. |
| exactPhraseScoreMergePolicy | enum(SUM, MAX) | SUM | Specifies how to merge the underlying word scores of an exact phrase. Setting the policy to 'MAX' will score the phrase as a single term. |
| Type | Wrapper | Description |
| GroupConfig* | - | Configures collapsing TODO. |
| ProximityBoostConfig | - | How to boost a document score depending on the proximity of the query terms. |
| SortConfig | - | Configures the fields to use to sort documents in the result list. |
| TermScoreConfig | - | How to compute the score of a term in a matching document. |
GroupBy child elemement specifies the grouping criteria. The order of GroupBy
child elements does not affect sort order. The SortHitsInGroupBy child elements defines lexicographical order to sort hits within the group. By default, it uses SortConfiguration order.
Aggregation child elements specify the summary operation (SUM, MIN, MAX, and so on) to perform on all hits (discarded + top/bottom N) within a group.
| Name | Type | Default value | Description |
| topN | int | 1 | Maximum number of hits to display for a group. The remaining hits do not display in search results. Must be strictly positive. |
| Type | Wrapper | Description |
| Aggregation* | - | Aggregation(s) to be evaluated sequentially on all the hits within a group, and stored as a virtual expression meta. To display the aggregation value in the grouped hit(s), add this meta name as a Hit content meta. |
| GroupBy* | - | Virtual expressions used to group, or collapse, hits in search results. Hits with the same value for an expression form one group. Hits with undefined values for the expression are never grouped. If empty, displays all hits in the search results. As with any virtual expression, it requires RAM-based index fields. |
| SortHitsInGroupBy* | - | Ordered list of expressions for sorting hits. The sort direction identifies the top N hits of a group. Hits with defined values are always listed higher than hits with undefined values. If empty, it uses the SortConfig by default. As with any virtual expression, it requires RAM-based index fields. |
| Name | Type | Default value | Description |
| expr | string | - | Field to compute on the grouped hits. |
| aggregationField | string | - | |
| function | enum(AVG, MAX, MIN, SUM, STDDEV, CONCAT) | MAX | Aggregation function to apply on the specified expression.
|
| separator | string | - | Character to separate concatenated strings. |
| Name | Type | Default value | Description |
| expr | string | - | Virtual expression to compare. |
| LSB | int | 0 | Position of the least significant bit to be considered. Applies to integer values only, ignored otherwize. |
| MSB | int | 63 | Position of the most significant bit to be considered. Applies to integer values only, ignored otherwize. |
| limit | int | 0 | Maximum number of characters to consider when comparing string values.
0 means the string is compared till the end. Applies to alphanumerical values only, ignored otherwize. |
| Name | Type | Default value | Description |
| name | string | - | Unique sort name. |
| expr | string | - | Virtual expression to compare. |
| LSB | int | 0 | Position of the least significant bit to be considered. Applies to integer values only. |
| MSB | int | 63 | Position of the most significant bit to be considered. Applies to integer values only. |
| limit | int | 0 | Maximum number of characters to use when matching string values.
0 means the entire string is used for matching. Applies to alphanumerical values only. |
| min | long | 0 | Minimum value needed for a the document to be returned by the query. Applies to integer and double values only. 0 means keep all documents. Discards documents with a value below the minimum. Keeps documents with undefined value for this field. |
| order | enum(asc, desc) | desc | Sort order Value can be null or one of
|
| active | boolean | True | Defines if the sort is applied by default. |
| Name | Type | Default value | Description |
| enabled | boolean | True | Enables proximity calculation globally. When disabled, @proximity is always 1.0 |
| maxDistance | int | 100 | Do not apply proximity boost if words are separated by more than 'maxDistance' words. |
| Name | Type | Default value | Description |
| discardInvalidSort | boolean | False | Auto discard sortBy not allowed rather than sending an error. |
| Type | Wrapper | Description |
| SortBy* | - | Ordered list of expresion that defines a lexicographical order (documents having the same value for the first criteria are then ordered using the second critera, and so on). |
| Name | Type | Default value | Description |
| name | string | - | Unique sort name. |
| expr | string | - | Virtual expression to compare. |
| LSB | int | 0 | Position of the least significant bit to be considered. Applies to integer values only. |
| MSB | int | 63 | Position of the most significant bit to be considered. Applies to integer values only. |
| limit | int | 0 | Maximum number of characters to use when matching string values.
0 means the entire string is used for matching. Applies to alphanumerical values only. |
| min | long | 0 | Minimum value needed for a the document to be returned by the query. Applies to integer and double values only. 0 means keep all documents. Discards documents with a value below the minimum. Keeps documents with undefined value for this field. |
| order | enum(asc, desc) | desc | Sort order Value can be null or one of
|
| active | boolean | True | Defines if the sort is applied by default. |
| Name | Type | Default value | Description |
| type | enum(RANK_TFIDF, TFIDF, RANK, BM25, BM25F, NO_RANKING, IDF, RANK_IDF, CUSTOM, CUSTOM_LUA) | NO_RANKING | Select the ranking policy ( Value can be null or one of
|
| scoreMap | string | - | Comma-separated list of target weights for the ranking scores. XXX: Should be cleanly documented elsewhere. |
| customExpr | string | - | |
| customLuaScript | string | - |
| Name | Type | Default value | Description |
| secondarySortKey | boolean | False | Allows disambiguating documents having the same score, on a configurable key. The rest of the comparator configuration is similar to the primary sort. If this option is enabled, the documents will be compared by score, and in case of equality, only by the key extracted from the configurable index field. |
| indexField | string | - | Index field on which we want to sort. You can only sort on an unsigned index field. |
| ascending | boolean | False | Inverse the total order relation. |
| LSB | int | 0 | Least Significant Bit of the key inside the field. |
| MSB | int | 63 | Most Significant Bit of the key inside the field. |
| hasInvalidValue | boolean | False | Should one of the keys be considered as excluded from the set and always put at the end |
| invalidValue | long | - | If hasInvalidValue is true, what is the invalid value? |
| Name | Type | Default value | Description |
| enabled (UI: Enable) |
boolean | False | Enables spellcheck on queries. |
| blacklistedPrefixHandlers | string | A list of comma-separated prefix handler names defining which parts of the query will NOT be spell checked . | |
| enabledRefine (UI: Use with facets) |
boolean | False | Suggests alternate expressions even if facets have been used to filter hits. |
| computeCorrectedNHits (UI: Calculate no. hits) |
boolean | False | Calculates and displays the number of hits that will be returned for each suggested expression. This can impact performance as CloudView must perform the query for each suggestion. Warning: This option is not compatible with disjunctive facets. The count will not report any values. |
| hitThreshold (UI: Disable at N hits) |
int | 0 | Only performs spell check if the query returns less than N hits. However, if N=0, spell check is always performed. For example, if N=4, spell check is only activated for queries that return 3 or less hits. |
| cancelBadCorrections (UI: Remove weak suggestions) |
boolean | False | Leaves out alternate expressions that would return less hits than the original query. This requires computeCorrectedNHits to be true. |
| autoCorrect (UI: Automatically correct) |
boolean | False | Automatically performs (uncorrected query) OR (corrected query 1) OR (corrected query 2) ... If cancelBadCorrections and autoCorrect are both true, the query is performed three times:
|
| graceDelayMS (UI: Timeout(ms)) |
int | 50 | Maximum time to wait for spell checking after query processing has finished. If the spell check exceeds this time, it is cancelled and a warning displays. After this time expires, spellcheck is cancelled. If computeCorrectedNHits is enabled, the additional time this takes will leave less time for spell check to finish. If 'Automatically correct' is selected, this timeout is ignored. |
| querySizeLimit | int | 16 | Queries with more than this count of chunks are considered computer-generated queries for which the spellchecking is disabled. |
| dictionaryName (UI: Dictionary) |
string | - | Dictionary used for spell checking and allow/block lists |
| Type | Wrapper | Description |
| SpellCheckParameters | - | Low-level parameters. |
| Name | Type | Default value | Description |
| maxApprox (UI: Max spellings per word) |
int | 40 | Maximum number of alternate spellings to retrieve for each word. |
| insertion (UI: Insertion) |
double | 0.8 | Damerau-Levenshtein distance incurred for inserting a letter. |
| deletion (UI: Deletion) |
double | 0.9 | Damerau-Levenshtein distance incurred for deleting a letter. |
| substitution (UI: Substitution) |
double | 0.9 | Damerau-Levenshtein distance incurred for substituting a letter. |
| transposition (UI: Transposing) |
double | 0.9 | Damerau-Levenshtein distance incurred for transposing letters. |
| first (UI: First letter) |
double | 0.1 | Additional Damerau-Levenshtein distance incurred for any operation on the first letter of a word. |
| blank (UI: Blank space) |
double | 0.5 | Damerau-Levenshtein distance incurred for inserting or deleting a space. |
| phoneticDist (UI: Phonetic matches) |
double | 0.1 | Damerau-Levenshtein distance incurred for phonetic matches. |
| precision (UI: Precision) |
double | 1.0 | The higher the precision, the less often alternatives are proposed; the lower, the more recall. |
| minLengthCandidate (UI: Min word length for distance 1) |
int | 4 | Minimum length for a word to trigger a distance 1 spell check. |
| minLengthCandidate2 (UI: Min word length for distance 2) |
int | 8 | Minimum length for a word to trigger a distance 2 spell check. |
| minLengthMultiWordCandidate (UI: Min word length anywhere for distance 1) |
int | 2 | Minimum length for a word anywhere in a multi-word expression to trigger a distance 1 spell check. |
| minLengthMultiWordCandidate2 (UI: Min word length anywhere for distance 2) |
int | 8 | Minimum length for a word anywhere in a multi-word expression to trigger a distance 2 spell check. |
| minLengthInsideMultiWordCandidate (UI: Min word length mid-expression for distance 1) |
int | 1 | Minimum length for a word in the middle of a multi-word expression to trigger a distance 1 spell check. |
| minLengthInsideMultiWordCandidate2 (UI: Min word length mid-expression for distance 2) |
int | 6 | Minimum length for a word in the middle of a multi-word expression to trigger a distance 2 spell check. |
| minNGramLengthForDist2 (UI: Min expression length for distance 2) |
int | 12 | Minimum length for a multi-word expression to trigger a distance 2 spell check. |
| filterWhiteList (UI: Apply min lengths to allow list) |
boolean | False | Applies minimum length criteria on allow list entries. |
| filterPhonetic (UI: Apply min lengths to phonetic) |
boolean | True | Applies the minimum length criteria on phonetic matches. |
| tokenizeResults (UI: Tokenize results) |
boolean | False | Tokenizes the suggested expression, and annotates each token with the corresponding word from the original query. This allows for additional processing after spellchecking, such as lemmatization, and normalization. For example, for a suggested expression of 3 tokens: - If true: each token has an annotation representing the associated word from the original user query. - If false: The first token is annotated with 3 tokens and a length of 3. |
| maxSuggestions (UI: Max. suggestions) |
int | 1 | Suggests no more than N alternate expressions |
| allSuggestionsMustAlwaysBeRetrieved (UI: Keep poor suggestions) |
boolean | False | Suggests alternate expressions even when they have a lower score than the corresponding expression from the original query. The score is determined by an algorithm that considers both the Damerau-Levenshtein distance and frequency in the corpus. |
| whitelist | string | - | Reference a dictionary's spellcheck allow list resource. Used to always suggest expressions for the listed words. |
| blacklist | string | - | Reference a dictionary's spellcheck block list resource. Used to never suggest expressions for the listed words. |
| timeoutMS (UI: timeout) |
int | 0 | Time allotted to the computing of spell suggestions. |
| Type | Wrapper | Description |
| SpellCheckBlackList | - | Never suggest expressions for these words. |
| SpellCheckWhiteList | - | Always suggest expressions for these words. |
| Name | Type | Default value | Description |
| lang | iso code | - | |
| expression | string | - | |
| level | enum(exact, lowercase, normalized) | normalized |
| Type | Wrapper | Description |
| SpellCheckEntry* | - |
| Name | Type | Default value | Description |
| lang | iso code | - | |
| expression | string | - | |
| level | enum(exact, lowercase, normalized) | normalized | |
| suggestion | string | - |
| Name | Type | Default value | Description |
| add | boolean | True | If true, the hours and minutes will be added. Otherwise, they will be substracted. |
| hours | int | 0 | Difference of hours to apply. |
| minutes | int | 0 | Difference of minutes to apply. |
| Name | Type | Default value | Description |
| defaultPrefixHandler | string | text | Prefix handler to use for content that is not contained within a specific prefix handler. |
| missingPrefixBehaviour | enum(error, remove, ignore, and, replace_by_false) | error | Action to perform when a prefix:value query does not reference a valid prefix:
|
| phraseQueryTriggerChars | string | .-& | List of chars inside a word that trigger a sequence match, for example, a.b will be rewritten as "a b". |
| queryTemplate | string | #and(#query(_default_) #query(refine) #query(security) #query(restriction) #query(date_restriction) #query(geo_restriction)) | Default query template to use (conjunction of query, refine, security and content restriction by default) |
| defaultLanguage | string | xx | Default language of the query |
| Type | Wrapper | Description |
| LogicRunnerCustomization | - | |
| ParsingConfig | - | |
| PatternsExpansionConfig | - | |
| QueryExpansionConfig | - | |
| QueryExpansionModule* | - | |
| QueryPrefixHandler* | - | |
| SWConfig | - | |
| SemanticQueryAnalysisConfig | - | Semantic analysis and rewriting of queries |
| Type | Wrapper | Description |
| CustomProcessor* | globalPreParseProcessors | |
| CustomProcessor* | preParseProcessors | |
| CustomProcessor* | preLinguisticProcessors | |
| CustomProcessor* | preTransformProcessors | |
| CustomProcessor* | preMapProcessors | |
| CustomProcessor* | postMapProcessors | |
| CustomProcessor* | globalPostParseProcessors | |
| CustomProcessor* | globalFinalProcessors |
| Name | Type | Default value | Description |
| classId | string | - | Must implement com.exalead.search.query.processors.CustomQueryProcessor |
| Type | Wrapper | Description |
| KeyValue* | - |
| Name | Type | Default value | Description |
| allowOptions | boolean | False | Allows word options in user query. |
| nearDistance | int | 16 | Default distance for NEAR queries |
| fallbackOnError | boolean | False | If the standard parsing fails, parses the query with a relaxed grammar, meaning it will split words on white spaces. Note that in some cases, operators and prefix handlers will not be taken into account for the query. For example, a query that ends with an AND will normally return an error. If this option is selected, CloudView will search for "AND" instead of considering it as an operator. See also missingPrefixBehaviour in UQLConfig |
| fallbackReportMode | enum(quiet, local, global) | local | Specifies how to report a search error in 'Troubleshooting > Logs':
|
| maxQuerySize | int | - | Queries larger than N are rejected. 0 means no limit. @unimplemented. |
| oversizedQueryReportMode | enum(quiet, local, global) | local | Specifies how to report an oversized query error in 'Troubleshooting > Logs':
|
| implicitSequenceOperator | enum(AND, OR) | AND | The default query operator. If a user enters this query: exalead cloudview (without quotes), by default, it will be parsed as "exalead AND cloudview". |
| Name | Type | Default value | Description |
| performRegexpExpansion | boolean | False | Allows query expansion on regular expressions. |
| minPrefixSize | int | 3 | Minimum number of characters required before wilcard (*) for pattern expansion to be carried out. |
| minSuffixSize | int | 3 | Minimum number of characters required after wilcard (*) for pattern expansion to be carried out. |
| expansionTimeout | long | - | Query expansion timeout for each pattern. |
| allLanguages | boolean | False | Performs query expansion on all languages, whatever the language of the orignal query. |
| rejectedPatternAction | enum(normalize, remove, error, keep) | error | Action to perform when a pattern is rejected (because
the prefix or suffix is too short, or the regular expression is disabled):
|
| rejectedPatternReportMode | enum(quiet, local, global) | local | Specifies how to report a rejected pattern error in 'Troubleshooting > Logs':
|
| errorAction | enum(normalize, remove, error) | error | Action to take when expansion fails:
|
| errorReportMode | enum(quiet, local, global) | local | Specifies how to report an expansion error in 'Troubleshooting > Logs':
|
| Name | Type | Default value | Description |
| timeoutMS | int | 500 | |
| unavailableDictionaryAction | enum(error, ignore) | error | Action to execute if the dictionary cannot be contacted for expansion.
|
| unavailableDictionaryReportMode | enum(quiet, global, local) | global | Value can be null or one of
|
| detectCJ | boolean | False | Tries to detect Chinese and Japanese in the query and override the language of the request accordingly. If false, it uses the user-specified language for expansion. |
| langDetect | boolean | True | Tries to detect the text language from its unicode range. If false, it uses the user-specified language for expansion (xx is the default one). |
| langDetectThreshold | double | 0.6 | If langDetect is True, it tries to detect the text language. That language will be used only if its proportion is superior to langDetectThreshold of the string length |
| longFormsPruningThreshold | int | 20 | Prunes forms spanning several shorter forms from query nodes larger than N tokens, to avoid combination. |
| performExactPhraseExpansion | boolean | False | Activates query expansion on expressions contained within quotation marks. In this case, a number of query expansion modules can be disabled by exactPhraseExpansionModulesBlackList. |
| exactPhraseExpansionModulesBlackList | string | If performExactPhraseExpansion is true, this list of comma-separated query expansion module names defines which modules are disabled when expanding exact phrases. |
| Type | Wrapper | Description |
| LangDetectMapping | - |
| Name | Type | Default value | Description |
| defaultDefault | iso code | xx | |
| defaultArabic | iso code | ar | |
| defaultCyrillic | iso code | ru |
| Name | Type | Default value | Description |
| name | string | - | Name of the module. Referenced to target this module in query expansion config. |
| classId | string | - | Full name of the Java class implementing the custom module. |
| Type | Wrapper | Description |
| KeyValue* | - |
| Name | Type | Default value | Description |
| name | string | - | Name of the module. Referenced to target this module in query expansion config. |
| language | string | - | Optional language code. If not specified, all are supported. |
| resourceFile | string | - | Optional phonetic rules file. If not specified, the default rules file is used. |
| Name | Type | Default value | Description |
| name | string | - | Name of the module. Referenced to target this module in query expansion config. |
| resourceDir | string | - | Optional resource directory. @unimplemented |
| Name | Type | Default value | Description |
| name | string | - | Name of the module. Referenced to target this module in query expansion config. |
| minSpan | int | 3 | Minimum number of words (excluding stop words) in a generated related term. |
| maxSpan | int | 6 | Maximal number of words (excluding stop words) in a generated related term. |
| keepLongestMatch | boolean | True | Keeps only the longest match. For example, if you have 5 tokens ('a', 'b', 'c', 'd', 'e') and 4 related terms 'a', 'a-c', 'b-c-d' and 'd-e'. This option will only keep 'b-c-d' and will remove all other related terms. |
| withPartOfSpeech | boolean | True | Automatically adds a PartOfSpeechTagger to the list of processors. |
| Name | Type | Default value | Description |
| name | string | - | Name of the module. Referenced to target this module in query expansion config. |
| minSpan | int | 2 | Minimum number of words (excluding stop words) in a generated related term. |
| maxSpan | int | 3 | Maximal number of words (excluding stop words) in a generated related term. |
| keepLongestMatch | boolean | True | Keeps only the longest match. For example, if you have 5 tokens ('a', 'b', 'c', 'd', 'e') and 4 related terms 'a', 'a-c', 'b-c-d' and 'd-e'. This option will only keep 'b-c-d' and will remove all other related terms. |
| withLemmatizer | boolean | True | Adds a Lemmatizer to the list of processors automatically. |
| withStopWordDict | boolean | True | Adds a StopWord dictionary to the list of processors automatically. |
| addCanonicalForm | boolean | False |
| Name | Type | Default value | Description |
| name | string | - | Name of the module. Referenced to target this module in query expansion config. |
| language | string | - | Language in which the lemmatization should be enabled. If null, all languages are enabled. |
| resourceDir | string | - | Optional resource dir, default value is resource:///lemmatizer/LANGUAGE |
| Name | Type | Default value | Description |
| name | string | - | Name of the module. Referenced to target this module in query expansion config. |
| annotation | string | - | The annotation name to use for expansion. |
| indexKind | int | 2 | The targeted index kind (0: exact search, 1: lowercase search, 2: normalized search). |
| Type | Wrapper | Description |
| SemanticProcessor* | - | The underlying semantic processors plugged in the pipeline. |
| Name | Type | Default value | Description |
| name | string | - | Name of the module. Referenced to target this module in query expansion config. |
| resourceFile | string | - | The compiled synonyms configuration file, cannot be null. |
| scoreMultiWordsExpressionsAsSingleWords | boolean | False | If true, the multi-words synonym will have the maximum score of the underlying words multiplied by the number of original words spanned. By default, the sum is calculated. |
| Name | Type | Default value | Description |
| name | string | - | Name of the module. Referenced to target this module in query expansion config. |
| resourceFile | string | resource://normalization-exceptions/synonyms.bin | The compiled normalization exceptions, cannot be null. |
| Name | Type | Default value | Description |
| name | string | - | Name of the prefix handler that should be handled. This is the prefix name that can be used in user queries. For example, the query prefix handler named 'soundslike' allows you to write this query: 'soundslike:fowbar' |
| aliases | string | - | Comma-separated list of aliases for this prefix handler. Any of these aliases can be used in the query for this prefix handler. |
| queryExpansionConfig | string | - | Specifies how to expand the text content of this prefix handler. Note that this is sometimes meaningless, if the content is not a semantic chunk of data. |
| dataModelState | string | - | Is this query prefix handler managed by a data model?
@enum{null,auto,customized}. If null, this prefix handler is not related to a data model. If "auto", this prefix handler is auto-generated by a data model. If "customized", this prefix handler was auto-generated by a data model and then customized. |
| dataModelClass | string | - | If dataModelState is "auto" or "customized", you will find here the name of the DataModelClass that generated this QueryPrefixHandler. |
| dataModelProperty | string | - | If dataModelState is "auto" or "customized", you will find here the name of the DataModelProperty that generated this QueryPrefixHandler. |
| prefixMatch | boolean | False | The prefix handler matches all strings beginning with "name". For example, a prefix handler with name="prop" prefixMatch="true" will match "props:value" and "property:value". |
| template | string | - | Template to use to replace the content of this prefix handler. Occurrences of __QUERY__ inside of this template are replaced by the content itself. |
| Type | Wrapper | Description |
| QueryPrefixHandler | fromDataModel | If dataModelState is "customized", you will find here the
original prefix handler generated by the data model. Use this to easily revert to "auto" state from "customized". |
| Name | Type | Default value | Description |
| indexField | string | - | Index field to be targeted by this prefix. |
| name | string | - | Name of the prefix handler that should be handled. This is the prefix name that can be used in user queries. For example, the query prefix handler named 'soundslike' allows you to write this query: 'soundslike:fowbar' |
| aliases | string | - | Comma-separated list of aliases for this prefix handler. Any of these aliases can be used in the query for this prefix handler. |
| queryExpansionConfig | string | - | Specifies how to expand the text content of this prefix handler. Note that this is sometimes meaningless, if the content is not a semantic chunk of data. |
| dataModelState | string | - | Is this query prefix handler managed by a data model?
@enum{null,auto,customized}. If null, this prefix handler is not related to a data model. If "auto", this prefix handler is auto-generated by a data model. If "customized", this prefix handler was auto-generated by a data model and then customized. |
| dataModelClass | string | - | If dataModelState is "auto" or "customized", you will find here the name of the DataModelClass that generated this QueryPrefixHandler. |
| dataModelProperty | string | - | If dataModelState is "auto" or "customized", you will find here the name of the DataModelProperty that generated this QueryPrefixHandler. |
| prefixMatch | boolean | False | The prefix handler matches all strings beginning with "name". For example, a prefix handler with name="prop" prefixMatch="true" will match "props:value" and "property:value". |
| root | string | - | Root category for this prefix |
| form | enum(exact, lowercase, normalized) | normalized | Form of the category path. Value can be null or one of
|
| tokenizationConfig | string | - |
| Type | Wrapper | Description |
| QueryPrefixHandler | fromDataModel | If dataModelState is "customized", you will find here the
original prefix handler generated by the data model. Use this to easily revert to "auto" state from "customized". |
| Name | Type | Default value | Description |
| indexField | string | - | Index field to be targeted by this prefix. |
| name | string | - | Name of the prefix handler that should be handled. This is the prefix name that can be used in user queries. For example, the query prefix handler named 'soundslike' allows you to write this query: 'soundslike:fowbar' |
| aliases | string | - | Comma-separated list of aliases for this prefix handler. Any of these aliases can be used in the query for this prefix handler. |
| queryExpansionConfig | string | - | Specifies how to expand the text content of this prefix handler. Note that this is sometimes meaningless, if the content is not a semantic chunk of data. |
| dataModelState | string | - | Is this query prefix handler managed by a data model?
@enum{null,auto,customized}. If null, this prefix handler is not related to a data model. If "auto", this prefix handler is auto-generated by a data model. If "customized", this prefix handler was auto-generated by a data model and then customized. |
| dataModelClass | string | - | If dataModelState is "auto" or "customized", you will find here the name of the DataModelClass that generated this QueryPrefixHandler. |
| dataModelProperty | string | - | If dataModelState is "auto" or "customized", you will find here the name of the DataModelProperty that generated this QueryPrefixHandler. |
| prefixMatch | boolean | False | The prefix handler matches all strings beginning with "name". For example, a prefix handler with name="prop" prefixMatch="true" will match "props:value" and "property:value". |
| excluded | boolean | False | Specifies whether the category must be included or excluded. |
| Type | Wrapper | Description |
| QueryPrefixHandler | fromDataModel | If dataModelState is "customized", you will find here the
original prefix handler generated by the data model. Use this to easily revert to "auto" state from "customized". |
| Name | Type | Default value | Description |
| meta | string | - | Meta name to search within. If null, you need to use the syntax prefix:meta:VALUE |
| invalidValueAction | enum(remove, ignore, error) | error | What to do when an invalid numerical value is passed:
|
| indexField | string | - | Index field to be targeted by this prefix. |
| name | string | - | Name of the prefix handler that should be handled. This is the prefix name that can be used in user queries. For example, the query prefix handler named 'soundslike' allows you to write this query: 'soundslike:fowbar' |
| aliases | string | - | Comma-separated list of aliases for this prefix handler. Any of these aliases can be used in the query for this prefix handler. |
| queryExpansionConfig | string | - | Specifies how to expand the text content of this prefix handler. Note that this is sometimes meaningless, if the content is not a semantic chunk of data. |
| dataModelState | string | - | Is this query prefix handler managed by a data model?
@enum{null,auto,customized}. If null, this prefix handler is not related to a data model. If "auto", this prefix handler is auto-generated by a data model. If "customized", this prefix handler was auto-generated by a data model and then customized. |
| dataModelClass | string | - | If dataModelState is "auto" or "customized", you will find here the name of the DataModelClass that generated this QueryPrefixHandler. |
| dataModelProperty | string | - | If dataModelState is "auto" or "customized", you will find here the name of the DataModelProperty that generated this QueryPrefixHandler. |
| prefixMatch | boolean | False | The prefix handler matches all strings beginning with "name". For example, a prefix handler with name="prop" prefixMatch="true" will match "props:value" and "property:value". |
| defaultOperator | enum(eq, le, lt, ge, gt, ne, range) | eq | Default numerical operator to use if the field is given with ':' |
| Type | Wrapper | Description |
| QueryPrefixHandler | fromDataModel | If dataModelState is "customized", you will find here the
original prefix handler generated by the data model. Use this to easily revert to "auto" state from "customized". |
| Name | Type | Default value | Description |
| meta | string | - | Meta name to search within. If null, you need to use the syntax prefix:meta:VALUE |
| invalidValueAction | enum(remove, ignore, error) | error | What to do when an invalid numerical value is passed:
|
| indexField | string | - | Index field to be targeted by this prefix. |
| name | string | - | Name of the prefix handler that should be handled. This is the prefix name that can be used in user queries. For example, the query prefix handler named 'soundslike' allows you to write this query: 'soundslike:fowbar' |
| aliases | string | - | Comma-separated list of aliases for this prefix handler. Any of these aliases can be used in the query for this prefix handler. |
| queryExpansionConfig | string | - | Specifies how to expand the text content of this prefix handler. Note that this is sometimes meaningless, if the content is not a semantic chunk of data. |
| dataModelState | string | - | Is this query prefix handler managed by a data model?
@enum{null,auto,customized}. If null, this prefix handler is not related to a data model. If "auto", this prefix handler is auto-generated by a data model. If "customized", this prefix handler was auto-generated by a data model and then customized. |
| dataModelClass | string | - | If dataModelState is "auto" or "customized", you will find here the name of the DataModelClass that generated this QueryPrefixHandler. |
| dataModelProperty | string | - | If dataModelState is "auto" or "customized", you will find here the name of the DataModelProperty that generated this QueryPrefixHandler. |
| prefixMatch | boolean | False | The prefix handler matches all strings beginning with "name". For example, a prefix handler with name="prop" prefixMatch="true" will match "props:value" and "property:value". |
| time | boolean | False | Allows a "date+time" input. |
| defaultOperator | enum(eq, le, lt, ge, gt, ne, range) | eq | Default numerical operator to use if the field is given with ':' |
| Type | Wrapper | Description |
| QueryPrefixHandler | fromDataModel | If dataModelState is "customized", you will find here the
original prefix handler generated by the data model. Use this to easily revert to "auto" state from "customized". |
| Name | Type | Default value | Description |
| semanticContent | boolean | true | Is the content of this prefix "semantic"? If false, the content will not be tokenized nor passed through the linguistic expansion phase. |
| indexFields | string | - | Comma-separated list of index fields to be targeted by this prefix handler. |
| performMAX | boolean | False | Should we perform a MAX-like query rather than simple OR when targeting multiple fields? |
| patternMaxMatches | int | 50 | Max number of matches for the patterns under this prefix handler. |
| tokenizationConfig | string | - | Tokenization Config to use. |
| meta | string | - | Meta name to search within. If null, you need to use the syntax prefix:meta:VALUE |
| invalidValueAction | enum(remove, ignore, error) | error | What to do when an invalid numerical value is passed:
|
| indexField | string | - | Index field to be targeted by this prefix. |
| name | string | - | Name of the prefix handler that should be handled. This is the prefix name that can be used in user queries. For example, the query prefix handler named 'soundslike' allows you to write this query: 'soundslike:fowbar' |
| aliases | string | - | Comma-separated list of aliases for this prefix handler. Any of these aliases can be used in the query for this prefix handler. |
| queryExpansionConfig | string | - | Specifies how to expand the text content of this prefix handler. Note that this is sometimes meaningless, if the content is not a semantic chunk of data. |
| dataModelState | string | - | Is this query prefix handler managed by a data model?
@enum{null,auto,customized}. If null, this prefix handler is not related to a data model. If "auto", this prefix handler is auto-generated by a data model. If "customized", this prefix handler was auto-generated by a data model and then customized. |
| dataModelClass | string | - | If dataModelState is "auto" or "customized", you will find here the name of the DataModelClass that generated this QueryPrefixHandler. |
| dataModelProperty | string | - | If dataModelState is "auto" or "customized", you will find here the name of the DataModelProperty that generated this QueryPrefixHandler. |
| prefixMatch | boolean | False | The prefix handler matches all strings beginning with "name". For example, a prefix handler with name="prop" prefixMatch="true" will match "props:value" and "property:value". |
| matchingMode | enum(exact, lowercase, normalized, exact_lowercase, exact_lowercase_normalized, lowercase_normalized) | normalized | The matching mode defines how the query words are looked up
in the index. Value can be null or one of
|
| Type | Wrapper | Description |
| QueryPrefixHandler | fromDataModel | If dataModelState is "customized", you will find here the
original prefix handler generated by the data model. Use this to easily revert to "auto" state from "customized". |
| Name | Type | Default value | Description |
| semanticContent | boolean | true | Is the content of this prefix "semantic"? If false, the content will not be tokenized nor passed through the linguistic expansion phase. |
| indexFields | string | - | Comma-separated list of index fields to be targeted by this prefix handler. |
| performMAX | boolean | False | Should we perform a MAX-like query rather than simple OR when targeting multiple fields? |
| patternMaxMatches | int | 50 | Max number of matches for the patterns under this prefix handler. |
| tokenizationConfig | string | - | Tokenization Config to use. |
| meta | string | - | Meta name to search within. If null, you need to use the syntax prefix:meta:VALUE |
| invalidValueAction | enum(remove, ignore, error) | error | What to do when an invalid numerical value is passed:
|
| indexField | string | - | Index field to be targeted by this prefix. |
| name | string | - | Name of the prefix handler that should be handled. This is the prefix name that can be used in user queries. For example, the query prefix handler named 'soundslike' allows you to write this query: 'soundslike:fowbar' |
| aliases | string | - | Comma-separated list of aliases for this prefix handler. Any of these aliases can be used in the query for this prefix handler. |
| queryExpansionConfig | string | - | Specifies how to expand the text content of this prefix handler. Note that this is sometimes meaningless, if the content is not a semantic chunk of data. |
| dataModelState | string | - | Is this query prefix handler managed by a data model?
@enum{null,auto,customized}. If null, this prefix handler is not related to a data model. If "auto", this prefix handler is auto-generated by a data model. If "customized", this prefix handler was auto-generated by a data model and then customized. |
| dataModelClass | string | - | If dataModelState is "auto" or "customized", you will find here the name of the DataModelClass that generated this QueryPrefixHandler. |
| dataModelProperty | string | - | If dataModelState is "auto" or "customized", you will find here the name of the DataModelProperty that generated this QueryPrefixHandler. |
| prefixMatch | boolean | False | The prefix handler matches all strings beginning with "name". For example, a prefix handler with name="prop" prefixMatch="true" will match "props:value" and "property:value". |
| kind | int | - |
| Type | Wrapper | Description |
| QueryPrefixHandler | fromDataModel | If dataModelState is "customized", you will find here the
original prefix handler generated by the data model. Use this to easily revert to "auto" state from "customized". |
| Name | Type | Default value | Description |
| defaultOperator | enum(eq, le, lt, ge, gt, ne, range) | eq | Default numerical operator to use if the field is given with ':' |
| invalidValueAction | enum(remove, ignore, error) | error | What to do when an invalid numerical value is passed:
|
| useRetrieved | boolean | False | Search using the "retrieved" part of the index. Searching in the retrieved part of a numerical field is faster when this condition is not very restrictive (i.e. when it does not divide the result set by more than 5). It also provides the ability to restrict search to a range of bits in the numerical field. However, it can only be used on retrievable fields. Note that using this prefix handler is the only way to search in virtual fields. |
| lsb | int | 0 | Least significant bit to search in (only if using retrieved) |
| msb | int | 63 | Most significant bit to search in (only if using retrieved) |
| indexField | string | - | Index field to be targeted by this prefix. |
| name | string | - | Name of the prefix handler that should be handled. This is the prefix name that can be used in user queries. For example, the query prefix handler named 'soundslike' allows you to write this query: 'soundslike:fowbar' |
| aliases | string | - | Comma-separated list of aliases for this prefix handler. Any of these aliases can be used in the query for this prefix handler. |
| queryExpansionConfig | string | - | Specifies how to expand the text content of this prefix handler. Note that this is sometimes meaningless, if the content is not a semantic chunk of data. |
| dataModelState | string | - | Is this query prefix handler managed by a data model?
@enum{null,auto,customized}. If null, this prefix handler is not related to a data model. If "auto", this prefix handler is auto-generated by a data model. If "customized", this prefix handler was auto-generated by a data model and then customized. |
| dataModelClass | string | - | If dataModelState is "auto" or "customized", you will find here the name of the DataModelClass that generated this QueryPrefixHandler. |
| dataModelProperty | string | - | If dataModelState is "auto" or "customized", you will find here the name of the DataModelProperty that generated this QueryPrefixHandler. |
| prefixMatch | boolean | False | The prefix handler matches all strings beginning with "name". For example, a prefix handler with name="prop" prefixMatch="true" will match "props:value" and "property:value". |
| Type | Wrapper | Description |
| QueryPrefixHandler | fromDataModel | If dataModelState is "customized", you will find here the
original prefix handler generated by the data model. Use this to easily revert to "auto" state from "customized". |
| Name | Type | Default value | Description |
| defaultOperator | enum(eq, le, lt, ge, gt, ne, range) | eq | Default numerical operator to use if the field is given with ':' |
| invalidValueAction | enum(remove, ignore, error) | error | What to do when an invalid numerical value is passed:
|
| useRetrieved | boolean | False | Search using the "retrieved" part of the index. Searching in the retrieved part of a numerical field is faster when this condition is not very restrictive (i.e. when it does not divide the result set by more than 5). It also provides the ability to restrict search to a range of bits in the numerical field. However, it can only be used on retrievable fields. Note that using this prefix handler is the only way to search in virtual fields. |
| lsb | int | 0 | Least significant bit to search in (only if using retrieved) |
| msb | int | 63 | Most significant bit to search in (only if using retrieved) |
| indexField | string | - | Index field to be targeted by this prefix. |
| name | string | - | Name of the prefix handler that should be handled. This is the prefix name that can be used in user queries. For example, the query prefix handler named 'soundslike' allows you to write this query: 'soundslike:fowbar' |
| aliases | string | - | Comma-separated list of aliases for this prefix handler. Any of these aliases can be used in the query for this prefix handler. |
| queryExpansionConfig | string | - | Specifies how to expand the text content of this prefix handler. Note that this is sometimes meaningless, if the content is not a semantic chunk of data. |
| dataModelState | string | - | Is this query prefix handler managed by a data model?
@enum{null,auto,customized}. If null, this prefix handler is not related to a data model. If "auto", this prefix handler is auto-generated by a data model. If "customized", this prefix handler was auto-generated by a data model and then customized. |
| dataModelClass | string | - | If dataModelState is "auto" or "customized", you will find here the name of the DataModelClass that generated this QueryPrefixHandler. |
| dataModelProperty | string | - | If dataModelState is "auto" or "customized", you will find here the name of the DataModelProperty that generated this QueryPrefixHandler. |
| prefixMatch | boolean | False | The prefix handler matches all strings beginning with "name". For example, a prefix handler with name="prop" prefixMatch="true" will match "props:value" and "property:value". |
| time | boolean | False | Allows a "date+time" input. |
| format | string | - |
| Type | Wrapper | Description |
| QueryPrefixHandler | fromDataModel | If dataModelState is "customized", you will find here the
original prefix handler generated by the data model. Use this to easily revert to "auto" state from "customized". |
| Name | Type | Default value | Description |
| defaultOperator | enum(eq, le, lt, ge, gt, ne, range) | eq | Default numerical operator to use if the field is given with ':' |
| invalidValueAction | enum(remove, ignore, error) | error | What to do when an invalid numerical value is passed:
|
| useRetrieved | boolean | False | Search using the "retrieved" part of the index. Searching in the retrieved part of a numerical field is faster when this condition is not very restrictive (i.e. when it does not divide the result set by more than 5). It also provides the ability to restrict search to a range of bits in the numerical field. However, it can only be used on retrievable fields. Note that using this prefix handler is the only way to search in virtual fields. |
| lsb | int | 0 | Least significant bit to search in (only if using retrieved) |
| msb | int | 63 | Most significant bit to search in (only if using retrieved) |
| indexField | string | - | Index field to be targeted by this prefix. |
| name | string | - | Name of the prefix handler that should be handled. This is the prefix name that can be used in user queries. For example, the query prefix handler named 'soundslike' allows you to write this query: 'soundslike:fowbar' |
| aliases | string | - | Comma-separated list of aliases for this prefix handler. Any of these aliases can be used in the query for this prefix handler. |
| queryExpansionConfig | string | - | Specifies how to expand the text content of this prefix handler. Note that this is sometimes meaningless, if the content is not a semantic chunk of data. |
| dataModelState | string | - | Is this query prefix handler managed by a data model?
@enum{null,auto,customized}. If null, this prefix handler is not related to a data model. If "auto", this prefix handler is auto-generated by a data model. If "customized", this prefix handler was auto-generated by a data model and then customized. |
| dataModelClass | string | - | If dataModelState is "auto" or "customized", you will find here the name of the DataModelClass that generated this QueryPrefixHandler. |
| dataModelProperty | string | - | If dataModelState is "auto" or "customized", you will find here the name of the DataModelProperty that generated this QueryPrefixHandler. |
| prefixMatch | boolean | False | The prefix handler matches all strings beginning with "name". For example, a prefix handler with name="prop" prefixMatch="true" will match "props:value" and "property:value". |
| time | boolean | True | Generates a DateTime. Otherwise, it generates a Date. |
| Type | Wrapper | Description |
| QueryPrefixHandler | fromDataModel | If dataModelState is "customized", you will find here the
original prefix handler generated by the data model. Use this to easily revert to "auto" state from "customized". |
| Name | Type | Default value | Description |
| indexField | string | - | Index field to be targeted by this prefix. |
| name | string | - | Name of the prefix handler that should be handled. This is the prefix name that can be used in user queries. For example, the query prefix handler named 'soundslike' allows you to write this query: 'soundslike:fowbar' |
| aliases | string | - | Comma-separated list of aliases for this prefix handler. Any of these aliases can be used in the query for this prefix handler. |
| queryExpansionConfig | string | - | Specifies how to expand the text content of this prefix handler. Note that this is sometimes meaningless, if the content is not a semantic chunk of data. |
| dataModelState | string | - | Is this query prefix handler managed by a data model?
@enum{null,auto,customized}. If null, this prefix handler is not related to a data model. If "auto", this prefix handler is auto-generated by a data model. If "customized", this prefix handler was auto-generated by a data model and then customized. |
| dataModelClass | string | - | If dataModelState is "auto" or "customized", you will find here the name of the DataModelClass that generated this QueryPrefixHandler. |
| dataModelProperty | string | - | If dataModelState is "auto" or "customized", you will find here the name of the DataModelProperty that generated this QueryPrefixHandler. |
| prefixMatch | boolean | False | The prefix handler matches all strings beginning with "name". For example, a prefix handler with name="prop" prefixMatch="true" will match "props:value" and "property:value". |
| matchingMode | enum(exact, lowercase, normalized, exact_lowercase, exact_lowercase_normalized, lowercase_normalized) | normalized | The matching mode defines how the query words are looked up
in the index. Value can be null or one of
|
| positionMatchMode | enum(exact, startsWith, endsWith) | exact | Choose between 'exact', 'startsWith' and 'endsWith' |
| tokenizationConfig | string | - |
| Type | Wrapper | Description |
| QueryPrefixHandler | fromDataModel | If dataModelState is "customized", you will find here the
original prefix handler generated by the data model. Use this to easily revert to "auto" state from "customized". |
| Name | Type | Default value | Description |
| indexField | string | - | Index field to be targeted by this prefix. |
| name | string | - | Name of the prefix handler that should be handled. This is the prefix name that can be used in user queries. For example, the query prefix handler named 'soundslike' allows you to write this query: 'soundslike:fowbar' |
| aliases | string | - | Comma-separated list of aliases for this prefix handler. Any of these aliases can be used in the query for this prefix handler. |
| queryExpansionConfig | string | - | Specifies how to expand the text content of this prefix handler. Note that this is sometimes meaningless, if the content is not a semantic chunk of data. |
| dataModelState | string | - | Is this query prefix handler managed by a data model?
@enum{null,auto,customized}. If null, this prefix handler is not related to a data model. If "auto", this prefix handler is auto-generated by a data model. If "customized", this prefix handler was auto-generated by a data model and then customized. |
| dataModelClass | string | - | If dataModelState is "auto" or "customized", you will find here the name of the DataModelClass that generated this QueryPrefixHandler. |
| dataModelProperty | string | - | If dataModelState is "auto" or "customized", you will find here the name of the DataModelProperty that generated this QueryPrefixHandler. |
| prefixMatch | boolean | False | The prefix handler matches all strings beginning with "name". For example, a prefix handler with name="prop" prefixMatch="true" will match "props:value" and "property:value". |
| additionalIndexField | string | - | |
| groupsByToRemove | string | Names of the GroupBy nodes to remove (comma-separated). |
| Type | Wrapper | Description |
| QueryPrefixHandler | fromDataModel | If dataModelState is "customized", you will find here the
original prefix handler generated by the data model. Use this to easily revert to "auto" state from "customized". |
| Name | Type | Default value | Description |
| indexField | string | - | Index field to be targeted by this prefix. |
| name | string | - | Name of the prefix handler that should be handled. This is the prefix name that can be used in user queries. For example, the query prefix handler named 'soundslike' allows you to write this query: 'soundslike:fowbar' |
| aliases | string | - | Comma-separated list of aliases for this prefix handler. Any of these aliases can be used in the query for this prefix handler. |
| queryExpansionConfig | string | - | Specifies how to expand the text content of this prefix handler. Note that this is sometimes meaningless, if the content is not a semantic chunk of data. |
| dataModelState | string | - | Is this query prefix handler managed by a data model?
@enum{null,auto,customized}. If null, this prefix handler is not related to a data model. If "auto", this prefix handler is auto-generated by a data model. If "customized", this prefix handler was auto-generated by a data model and then customized. |
| dataModelClass | string | - | If dataModelState is "auto" or "customized", you will find here the name of the DataModelClass that generated this QueryPrefixHandler. |
| dataModelProperty | string | - | If dataModelState is "auto" or "customized", you will find here the name of the DataModelProperty that generated this QueryPrefixHandler. |
| prefixMatch | boolean | False | The prefix handler matches all strings beginning with "name". For example, a prefix handler with name="prop" prefixMatch="true" will match "props:value" and "property:value". |
| Type | Wrapper | Description |
| QueryPrefixHandler | fromDataModel | If dataModelState is "customized", you will find here the
original prefix handler generated by the data model. Use this to easily revert to "auto" state from "customized". |
| Name | Type | Default value | Description |
| semanticContent | boolean | true | Is the content of this prefix handler "semantic"? If false, the content will neither be tokenized nor passed through the linguistic expansion phase. |
| indexFields (UI: Index fields) |
string | - | Comma-separated list of index fields targeted by this prefix handler. |
| indexFieldWeights (UI: Index fields weights) |
string | - | Optional comma-separated list of weights applied to each index field targeted by this prefix handler. |
| performMAX (UI: Perform MAX) |
boolean | False | Should we perform a MAX-like query rather than a simple OR when targeting multiple fields? |
| patternMaxMatches (UI: Max pattern matches) |
int | 50 | Max number of matches for the patterns under this prefix handler. |
| usePrefixedMappings | boolean | False | Prefixes the value with the prefix and #. This must be used with the "prefixWithContext" option of analysis mappings. For example: <FullTextPrefixHandler name='stuff' prefixMatch='true' usePrefixedMappings='true' indexField='everything'/> will transform: stuff_number1:test into: everything:stuff_number1#test |
| patternSearch (UI: Use field dictionaries for pattern search) |
boolean | False | Uses index field dictionaries for pattern expansion rather than linguistic dictionaries. |
| tokenizationConfig | string | - | |
| name | string | - | Name of the prefix handler that should be handled. This is the prefix name that can be used in user queries. For example, the query prefix handler named 'soundslike' allows you to write this query: 'soundslike:fowbar' |
| aliases | string | - | Comma-separated list of aliases for this prefix handler. Any of these aliases can be used in the query for this prefix handler. |
| queryExpansionConfig | string | - | Specifies how to expand the text content of this prefix handler. Note that this is sometimes meaningless, if the content is not a semantic chunk of data. |
| dataModelState | string | - | Is this query prefix handler managed by a data model?
@enum{null,auto,customized}. If null, this prefix handler is not related to a data model. If "auto", this prefix handler is auto-generated by a data model. If "customized", this prefix handler was auto-generated by a data model and then customized. |
| dataModelClass | string | - | If dataModelState is "auto" or "customized", you will find here the name of the DataModelClass that generated this QueryPrefixHandler. |
| dataModelProperty | string | - | If dataModelState is "auto" or "customized", you will find here the name of the DataModelProperty that generated this QueryPrefixHandler. |
| prefixMatch | boolean | False | The prefix handler matches all strings beginning with "name". For example, a prefix handler with name="prop" prefixMatch="true" will match "props:value" and "property:value". |
| matchingMode (UI: Matching mode) |
enum(exact, lowercase, normalized, exact_lowercase, exact_lowercase_normalized, lowercase_normalized, custom) | normalized | Normalization level for lookup of the words associated with this prefix handler. Using the 'custom' matching mode requires the custom kind to be set. Value can be null or one of
|
| customKind (UI: Custom kind) |
int | - | Custom indexing kind for lookup of the words associated with this prefix handler. This requires the matching mode to be set to 'custom'. Custom kinds must be used together with custom content targets at indexing time. |
| useNestedPrefixAsDynamicMetaName (UI: Use nested prefix as dyn. meta) |
boolean | False | Uses a nested prefix handler as dynamic meta name to search within a dynamic alphanumerical field. This requires the Store meta names option to be enabled on the dynamic field. This is incompatible with the "forcedDynamicMetaName" option. For example, on a prefix handler named "myprefix" configured to target a "mydynfield" index field, a "myprefix:mymeta:myvalue" query will search for "myvalue" into the "mymeta" meta of "mydynfield". Note that a "myprefix:myvalue" query will not lookup into any meta, and will not find anything. |
| forcedDynamicMetaName (UI: Dyn. meta name) |
string | - | Dynamic meta to search when targeting a dynamic alphanumerical field. Use this to restrict the search in a dynamic field to text that appears within this meta. This requires the Store meta names option to be enabled on the dynamic field. This is incompatible with the Use nested prefix as dyn. meta option. For example, with this option set to "mymeta", on a prefix handler named "myprefix" configured to target index field "mydynfield", a query "myprefix:myvalue" will search for "myvalue" into the "mymeta" meta of "mydynfield". It is possible to set a list of meta separated by ',' to mimic the behavior of a list of index fields (OR on the different metas) |
| dictionaryName (UI: Dictionary) |
string | - | Dictionary to target |
| Type | Wrapper | Description |
| QueryPrefixHandler | fromDataModel | If dataModelState is "customized", you will find here the
original prefix handler generated by the data model. Use this to easily revert to "auto" state from "customized". |
| Name | Type | Default value | Description |
| semanticContent | boolean | true | Is the content of this prefix handler "semantic"? If false, the content will neither be tokenized nor passed through the linguistic expansion phase. |
| indexFields (UI: Index fields) |
string | - | Comma-separated list of index fields targeted by this prefix handler. |
| indexFieldWeights (UI: Index fields weights) |
string | - | Optional comma-separated list of weights applied to each index field targeted by this prefix handler. |
| performMAX (UI: Perform MAX) |
boolean | False | Should we perform a MAX-like query rather than a simple OR when targeting multiple fields? |
| patternMaxMatches (UI: Max pattern matches) |
int | 50 | Max number of matches for the patterns under this prefix handler. |
| usePrefixedMappings | boolean | False | Prefixes the value with the prefix and #. This must be used with the "prefixWithContext" option of analysis mappings. For example: <FullTextPrefixHandler name='stuff' prefixMatch='true' usePrefixedMappings='true' indexField='everything'/> will transform: stuff_number1:test into: everything:stuff_number1#test |
| patternSearch (UI: Use field dictionaries for pattern search) |
boolean | False | Uses index field dictionaries for pattern expansion rather than linguistic dictionaries. |
| tokenizationConfig | string | - | |
| name | string | - | Name of the prefix handler that should be handled. This is the prefix name that can be used in user queries. For example, the query prefix handler named 'soundslike' allows you to write this query: 'soundslike:fowbar' |
| aliases | string | - | Comma-separated list of aliases for this prefix handler. Any of these aliases can be used in the query for this prefix handler. |
| queryExpansionConfig | string | - | Specifies how to expand the text content of this prefix handler. Note that this is sometimes meaningless, if the content is not a semantic chunk of data. |
| dataModelState | string | - | Is this query prefix handler managed by a data model?
@enum{null,auto,customized}. If null, this prefix handler is not related to a data model. If "auto", this prefix handler is auto-generated by a data model. If "customized", this prefix handler was auto-generated by a data model and then customized. |
| dataModelClass | string | - | If dataModelState is "auto" or "customized", you will find here the name of the DataModelClass that generated this QueryPrefixHandler. |
| dataModelProperty | string | - | If dataModelState is "auto" or "customized", you will find here the name of the DataModelProperty that generated this QueryPrefixHandler. |
| prefixMatch | boolean | False | The prefix handler matches all strings beginning with "name". For example, a prefix handler with name="prop" prefixMatch="true" will match "props:value" and "property:value". |
| kind | int | - |
| Type | Wrapper | Description |
| QueryPrefixHandler | fromDataModel | If dataModelState is "customized", you will find here the
original prefix handler generated by the data model. Use this to easily revert to "auto" state from "customized". |
| Name | Type | Default value | Description |
| name | string | - | Name of the prefix handler that should be handled. This is the prefix name that can be used in user queries. For example, the query prefix handler named 'soundslike' allows you to write this query: 'soundslike:fowbar' |
| aliases | string | - | Comma-separated list of aliases for this prefix handler. Any of these aliases can be used in the query for this prefix handler. |
| queryExpansionConfig | string | - | Specifies how to expand the text content of this prefix handler. Note that this is sometimes meaningless, if the content is not a semantic chunk of data. |
| dataModelState | string | - | Is this query prefix handler managed by a data model?
@enum{null,auto,customized}. If null, this prefix handler is not related to a data model. If "auto", this prefix handler is auto-generated by a data model. If "customized", this prefix handler was auto-generated by a data model and then customized. |
| dataModelClass | string | - | If dataModelState is "auto" or "customized", you will find here the name of the DataModelClass that generated this QueryPrefixHandler. |
| dataModelProperty | string | - | If dataModelState is "auto" or "customized", you will find here the name of the DataModelProperty that generated this QueryPrefixHandler. |
| prefixMatch | boolean | False | The prefix handler matches all strings beginning with "name". For example, a prefix handler with name="prop" prefixMatch="true" will match "props:value" and "property:value". |
| dictionaryName (UI: Dictionary) |
string | - | Dictionary to target |
| Type | Wrapper | Description |
| QueryPrefixHandler | fromDataModel | If dataModelState is "customized", you will find here the
original prefix handler generated by the data model. Use this to easily revert to "auto" state from "customized". |
| Name | Type | Default value | Description |
| name | string | - | Name of the prefix handler that should be handled. This is the prefix name that can be used in user queries. For example, the query prefix handler named 'soundslike' allows you to write this query: 'soundslike:fowbar' |
| aliases | string | - | Comma-separated list of aliases for this prefix handler. Any of these aliases can be used in the query for this prefix handler. |
| queryExpansionConfig | string | - | Specifies how to expand the text content of this prefix handler. Note that this is sometimes meaningless, if the content is not a semantic chunk of data. |
| dataModelState | string | - | Is this query prefix handler managed by a data model?
@enum{null,auto,customized}. If null, this prefix handler is not related to a data model. If "auto", this prefix handler is auto-generated by a data model. If "customized", this prefix handler was auto-generated by a data model and then customized. |
| dataModelClass | string | - | If dataModelState is "auto" or "customized", you will find here the name of the DataModelClass that generated this QueryPrefixHandler. |
| dataModelProperty | string | - | If dataModelState is "auto" or "customized", you will find here the name of the DataModelProperty that generated this QueryPrefixHandler. |
| prefixMatch | boolean | False | The prefix handler matches all strings beginning with "name". For example, a prefix handler with name="prop" prefixMatch="true" will match "props:value" and "property:value". |
| similarityThreshold | double | 0.1 | The mininum similarity score for two documents to be considered similar. Value must be between 0 and 1. |
| minNumberOfKeywordPerDoc | long | 5 | Documents with fewer keywords than this constant are ignored. Value must be higher or equal to 0. |
| minNumberOfMatchedKeywords | long | 4 | Documents that do not share at least this number of keywords with the reference document are ignored. Value must be higher or equal to 0. |
| similarityVirtualField | string | similarity | Name of the virtual field computing the final similarity score. |
| dictionary | string | dict0 | Related-terms dictionary to use. |
| keywordField | string | keywordv2 | Searchable value field indexing the related-terms. |
| Type | Wrapper | Description |
| QueryPrefixHandler | fromDataModel | If dataModelState is "customized", you will find here the
original prefix handler generated by the data model. Use this to easily revert to "auto" state from "customized". |
| Name | Type | Default value | Description |
| name | string | - | Name of the prefix handler that should be handled. This is the prefix name that can be used in user queries. For example, the query prefix handler named 'soundslike' allows you to write this query: 'soundslike:fowbar' |
| aliases | string | - | Comma-separated list of aliases for this prefix handler. Any of these aliases can be used in the query for this prefix handler. |
| queryExpansionConfig | string | - | Specifies how to expand the text content of this prefix handler. Note that this is sometimes meaningless, if the content is not a semantic chunk of data. |
| dataModelState | string | - | Is this query prefix handler managed by a data model?
@enum{null,auto,customized}. If null, this prefix handler is not related to a data model. If "auto", this prefix handler is auto-generated by a data model. If "customized", this prefix handler was auto-generated by a data model and then customized. |
| dataModelClass | string | - | If dataModelState is "auto" or "customized", you will find here the name of the DataModelClass that generated this QueryPrefixHandler. |
| dataModelProperty | string | - | If dataModelState is "auto" or "customized", you will find here the name of the DataModelProperty that generated this QueryPrefixHandler. |
| prefixMatch | boolean | False | The prefix handler matches all strings beginning with "name". For example, a prefix handler with name="prop" prefixMatch="true" will match "props:value" and "property:value". |
| sep | enum(INPARAGRAPH, INSENTENCE, INPAGE) | INPAGE | One of the separators: Value can be null or one of
|
| Type | Wrapper | Description |
| QueryPrefixHandler | fromDataModel | If dataModelState is "customized", you will find here the
original prefix handler generated by the data model. Use this to easily revert to "auto" state from "customized". |
| Name | Type | Default value | Description |
| name | string | - | Name of the prefix handler that should be handled. This is the prefix name that can be used in user queries. For example, the query prefix handler named 'soundslike' allows you to write this query: 'soundslike:fowbar' |
| aliases | string | - | Comma-separated list of aliases for this prefix handler. Any of these aliases can be used in the query for this prefix handler. |
| queryExpansionConfig | string | - | Specifies how to expand the text content of this prefix handler. Note that this is sometimes meaningless, if the content is not a semantic chunk of data. |
| dataModelState | string | - | Is this query prefix handler managed by a data model?
@enum{null,auto,customized}. If null, this prefix handler is not related to a data model. If "auto", this prefix handler is auto-generated by a data model. If "customized", this prefix handler was auto-generated by a data model and then customized. |
| dataModelClass | string | - | If dataModelState is "auto" or "customized", you will find here the name of the DataModelClass that generated this QueryPrefixHandler. |
| dataModelProperty | string | - | If dataModelState is "auto" or "customized", you will find here the name of the DataModelProperty that generated this QueryPrefixHandler. |
| prefixMatch | boolean | False | The prefix handler matches all strings beginning with "name". For example, a prefix handler with name="prop" prefixMatch="true" will match "props:value" and "property:value". |
| keywordField | string | keywordv2 | Name of the value-field where keywords are indexed. |
| Type | Wrapper | Description |
| QueryPrefixHandler | fromDataModel | If dataModelState is "customized", you will find here the
original prefix handler generated by the data model. Use this to easily revert to "auto" state from "customized". |
| Name | Type | Default value | Description |
| name | string | - | Name of the prefix handler that should be handled. This is the prefix name that can be used in user queries. For example, the query prefix handler named 'soundslike' allows you to write this query: 'soundslike:fowbar' |
| aliases | string | - | Comma-separated list of aliases for this prefix handler. Any of these aliases can be used in the query for this prefix handler. |
| queryExpansionConfig | string | - | Specifies how to expand the text content of this prefix handler. Note that this is sometimes meaningless, if the content is not a semantic chunk of data. |
| dataModelState | string | - | Is this query prefix handler managed by a data model?
@enum{null,auto,customized}. If null, this prefix handler is not related to a data model. If "auto", this prefix handler is auto-generated by a data model. If "customized", this prefix handler was auto-generated by a data model and then customized. |
| dataModelClass | string | - | If dataModelState is "auto" or "customized", you will find here the name of the DataModelClass that generated this QueryPrefixHandler. |
| dataModelProperty | string | - | If dataModelState is "auto" or "customized", you will find here the name of the DataModelProperty that generated this QueryPrefixHandler. |
| prefixMatch | boolean | False | The prefix handler matches all strings beginning with "name". For example, a prefix handler with name="prop" prefixMatch="true" will match "props:value" and "property:value". |
| enumFacetId | string | - | The EnumFacet id this prefix handler refers to. Value must be any non-empty string |
| mode | enum(exact, tolower, toupper) | exact | What to do with the prefix handler value:
|
| invalidValueAction | enum(remove, ignore, error) | error | What to do when an invalid value is passed:
|
| Type | Wrapper | Description |
| QueryPrefixHandler | fromDataModel | If dataModelState is "customized", you will find here the
original prefix handler generated by the data model. Use this to easily revert to "auto" state from "customized". |
| Name | Type | Default value | Description |
| name | string | - | Name of the prefix handler that should be handled. This is the prefix name that can be used in user queries. For example, the query prefix handler named 'soundslike' allows you to write this query: 'soundslike:fowbar' |
| aliases | string | - | Comma-separated list of aliases for this prefix handler. Any of these aliases can be used in the query for this prefix handler. |
| queryExpansionConfig | string | - | Specifies how to expand the text content of this prefix handler. Note that this is sometimes meaningless, if the content is not a semantic chunk of data. |
| dataModelState | string | - | Is this query prefix handler managed by a data model?
@enum{null,auto,customized}. If null, this prefix handler is not related to a data model. If "auto", this prefix handler is auto-generated by a data model. If "customized", this prefix handler was auto-generated by a data model and then customized. |
| dataModelClass | string | - | If dataModelState is "auto" or "customized", you will find here the name of the DataModelClass that generated this QueryPrefixHandler. |
| dataModelProperty | string | - | If dataModelState is "auto" or "customized", you will find here the name of the DataModelProperty that generated this QueryPrefixHandler. |
| prefixMatch | boolean | False | The prefix handler matches all strings beginning with "name". For example, a prefix handler with name="prop" prefixMatch="true" will match "props:value" and "property:value". |
| uqlQueries | string | - | Comma-separated list of additional UQL queries to build. Each UQL query is mapped to a specific prefix handler. |
| Type | Wrapper | Description |
| QueryPrefixHandler | fromDataModel | If dataModelState is "customized", you will find here the
original prefix handler generated by the data model. Use this to easily revert to "auto" state from "customized". |
| QueryPrefixHandler* | - | List of prefix handlers to query, identified by their names. |
| Name | Type | Default value | Description |
| name | string | - | Name of the prefix handler that should be handled. This is the prefix name that can be used in user queries. For example, the query prefix handler named 'soundslike' allows you to write this query: 'soundslike:fowbar' |
| aliases | string | - | Comma-separated list of aliases for this prefix handler. Any of these aliases can be used in the query for this prefix handler. |
| queryExpansionConfig | string | - | Specifies how to expand the text content of this prefix handler. Note that this is sometimes meaningless, if the content is not a semantic chunk of data. |
| dataModelState | string | - | Is this query prefix handler managed by a data model?
@enum{null,auto,customized}. If null, this prefix handler is not related to a data model. If "auto", this prefix handler is auto-generated by a data model. If "customized", this prefix handler was auto-generated by a data model and then customized. |
| dataModelClass | string | - | If dataModelState is "auto" or "customized", you will find here the name of the DataModelClass that generated this QueryPrefixHandler. |
| dataModelProperty | string | - | If dataModelState is "auto" or "customized", you will find here the name of the DataModelProperty that generated this QueryPrefixHandler. |
| prefixMatch | boolean | False | The prefix handler matches all strings beginning with "name". For example, a prefix handler with name="prop" prefixMatch="true" will match "props:value" and "property:value". |
| classId | string | - | Reference of the Java class that implements the query prefix handler. This class must implement the interface com.exalead.search.query.prefix.CustomPrefixHandler |
| Type | Wrapper | Description |
| QueryPrefixHandler | fromDataModel | If dataModelState is "customized", you will find here the
original prefix handler generated by the data model. Use this to easily revert to "auto" state from "customized". |
| KeyValue* | - |
| Name | Type | Default value | Description |
| name | string | - | Name of the prefix handler that should be handled. This is the prefix name that can be used in user queries. For example, the query prefix handler named 'soundslike' allows you to write this query: 'soundslike:fowbar' |
| aliases | string | - | Comma-separated list of aliases for this prefix handler. Any of these aliases can be used in the query for this prefix handler. |
| queryExpansionConfig | string | - | Specifies how to expand the text content of this prefix handler. Note that this is sometimes meaningless, if the content is not a semantic chunk of data. |
| dataModelState | string | - | Is this query prefix handler managed by a data model?
@enum{null,auto,customized}. If null, this prefix handler is not related to a data model. If "auto", this prefix handler is auto-generated by a data model. If "customized", this prefix handler was auto-generated by a data model and then customized. |
| dataModelClass | string | - | If dataModelState is "auto" or "customized", you will find here the name of the DataModelClass that generated this QueryPrefixHandler. |
| dataModelProperty | string | - | If dataModelState is "auto" or "customized", you will find here the name of the DataModelProperty that generated this QueryPrefixHandler. |
| prefixMatch | boolean | False | The prefix handler matches all strings beginning with "name". For example, a prefix handler with name="prop" prefixMatch="true" will match "props:value" and "property:value". |
| indexFieldTarget | string | - | The index field |
| indexFieldUnitSymbol | string | - | The output unit symbol |
| defaultUnitSymbol | string | - | (Optional) A default unit symbol |
| Type | Wrapper | Description |
| QueryPrefixHandler | fromDataModel | If dataModelState is "customized", you will find here the
original prefix handler generated by the data model. Use this to easily revert to "auto" state from "customized". |
| Name | Type | Default value | Description |
| stopWordsOnlyQueryAction | enum(perform, error, empty) | perform | What to do when a query contains only stop words. One of:
|
| stopWordsOnlyQueryReportMode | enum(global, local, quiet) | local | Specifies how to report a stop-word only query error in 'Troubleshooting > Logs':
|
| Type | Wrapper | Description |
| SWList* | - |
| Name | Type | Default value | Description |
| language | iso code | - | Language code |
| resourceFile | string | - | |
| action | enum(opt, remove) | opt | |
| level | enum(normalized, exact, lowercase) | exact |
| Name | Type | Default value | Description |
| resourceDir | string | - | URL for the directory containing the semantic extractor binaries (data://, file;// or resource://). |
| unusedWordPolicy | enum(mandatory, optional, remove, as-is) | mandatory | Unused query word policy |
| language | string | - | The query language for which the analyzer is activated. If null, it is activated whatever the language. |
| queryNames | string | _default_ | A list of comma-separated query names defining which parts of the query will be processed (default is _default_). |
| htmlLogPath | string | - | Path to a debug HTML file |
| singleMatch | boolean | True | If true, only the best match is selected for rewriting, if false, several rules may trigger simultaneously. |
| overlappingMatches | boolean | True | If true, allows rules to match on overlapping query parts. Only makes sense when singleMatch is false. |
| Type | Wrapper | Description |
| SemanticProcessor* | - | A list of semantic processor to apply before the semantic extractor. |
| Name | Type | Default value | Description |
| name | string | - | Name of this virtual field |
| expr | string | - | Virtual field expression |
| Name | Type | Default value | Description |
| targetName | string | - | The name of this search target. This is the name to use in the search-api to reference a particular search target. Value must be a string matching '[A-Za-z0-9_]+'. |
| watchDogConnectTimeoutMS | int | 1000 | Global 'connect' timeout for connection to index slices maintained by this search target. This is an advanced parameter that should generally not be modified. |
| watchDogReadTimeoutMS | int | 5000 | Global 'read' timeout for connection to index slices maintainted by this search target. This is an advanced parameter that should generally not be modified. |
| nbVirtualPartitionPerSlice | int | 1 | Split every slices of the target in nbVirtualPartitionPerSlice virtual partitions. Emulate multislice behavior on a single slice, each partition acting on a subpart of the physical slice. |
| buildGroups | string | - | Comma-separated list of build groups. All local instances of the slices of this build group "will be queried |
| Name | Type | Default value | Description |
| targetName | string | - | The name of this search target. This is the name to use in the search-api to reference a particular search target. Value must be a string matching '[A-Za-z0-9_]+'. |
| watchDogConnectTimeoutMS | int | 1000 | Global 'connect' timeout for connection to index slices maintained by this search target. This is an advanced parameter that should generally not be modified. |
| watchDogReadTimeoutMS | int | 5000 | Global 'read' timeout for connection to index slices maintainted by this search target. This is an advanced parameter that should generally not be modified. |
| nbVirtualPartitionPerSlice | int | 1 | Split every slices of the target in nbVirtualPartitionPerSlice virtual partitions. Emulate multislice behavior on a single slice, each partition acting on a subpart of the physical slice. |
| Type | Wrapper | Description |
| TargetSlices* | - | Slice instances to query in this target |
| Name | Type | Default value | Description |
| buildGroups | string | - | Comma-separated list of build groups. If null, all build groups are considered |
| slices | string | - | Comma-separated list of index slices. If null, all slices are considered |
| instances | string | - | Comma-separated list of slice instances. If null, all instances are considered |
| power | int | 1 | The power ratio defines the ratio of the inbound trafic to divert to a given instance (among all instances of a given slice). A slice instance with power=2 will receive twice as much traffic as a slice instance with power=1. If power=0, this slice instance is used as failover only if all other instances of this slice have failed. |
| Name | Type | Default value | Description |
| targetName | string | - | The name of this search target. This is the name to use in the search-api to reference a particular search target. Value must be a string matching '[A-Za-z0-9_]+'. |
| watchDogConnectTimeoutMS | int | 1000 | Global 'connect' timeout for connection to index slices maintained by this search target. This is an advanced parameter that should generally not be modified. |
| watchDogReadTimeoutMS | int | 5000 | Global 'read' timeout for connection to index slices maintainted by this search target. This is an advanced parameter that should generally not be modified. |
| nbVirtualPartitionPerSlice | int | 1 | Split every slices of the target in nbVirtualPartitionPerSlice virtual partitions. Emulate multislice behavior on a single slice, each partition acting on a subpart of the physical slice. |
| Type | Wrapper | Description |
| ContentGroupConfig* | - |
| Name | Type | Default value | Description |
| contentGroup | string | - | Name of the content group |
| type | string | - | Type of the content group. Must be used only as reference by custom code for complex multi-content groups installations. |
| Type | Wrapper | Description |
| BuildGroupConfig* | - |
| Name | Type | Default value | Description |
| buildGroup | string | - | Name of the build group. |
| Type | Wrapper | Description |
| BuildGroupException* | - | List of build group exceptions. |
| Name | Type | Default value | Description |
| slice | int | - | slice number |
| sliceInstance | string | - | Name of the instance |
| enabled | boolean | False | Enables search for this instance. |
| power | int | 1 | The power ratio defines the ratio of the inbound trafic to divert to a given instance (among all instances of a given slice). A slice instance with power=2 will receive twice as much traffic as a slice instance with power=1. If power=0, this slice instance is used as failover only if all other instances of this slice have failed. |
| Name | Type | Default value | Description |
| name | string | - | Name of this API config |
| extraClassPath | string | - | Extra classpath for the web application. Comma or semicolon separated path of filenames or URLs pointing to directories or jar files. Directories should end with '/'. Used for JDBC for reporting and custom dependencies. |
| Type | Wrapper | Description |
| Command* | - |
| Name | Type | Default value | Description |
| defaultLogic | string | - | Default search logic (can be overriden using API parameters). |
| defaultTarget | string | - | Default search target (can be overriden using API parameters). |
| targetReporting | string | - | Target reporting to use for the search queries. |
| customRunnerFactoryClassId | string | - | |
| maxConcurrentQueries | int | 0 | The maximum number of concurrent queries processed by the search server. If this limit is reached, incoming queries will be queued. 0 means the number of core of the search server times two. |
| maxWaitingQueries | int | 200 | When the maximum number of concurrent queries is reached the queries are put in a queue. This setting configures the maximum length of this queue. When this maximum is reached the query is rejected. |
| base | string | /search-api | HTTP path for this command |
| enableSOAP | boolean | False | |
| isAliveSynchronous | boolean | True | Should the query be performed synchronously on isAlive call or should it run in a background thread, and cached result be returned. |
| isAliveAsynchronousDelayS | int | 5 | Elapsed time between two queries if the query is performed asynchronously. |
| Type | Wrapper | Description |
| KeyValue* | customRunnerFactoryParams | |
| StringValue* | isAliveQueries | |
| SearchCache* | - | List of caches for this search command. Cache entries will be looked up in all caches, in the order in which they are given. Incoming queries will be inserted in the first cache which accepts them. This allows complex configurations where you warmup some queries, and don't want them to be evicted by regular traffic
<TimeBasedSearchCache name="time" cacheQueries="false">
<WarmUpQuery args="q=#all" />
</TimeBasedSearchCache>
<ConsistentSearchCache name="default" />
<SearchCommand caches="time,default" />
|
| Name | Type | Default value | Description |
| name | string | - | |
| warmupWorkRatio | double | 1.0 | Maximum ratio of time each warm-up thread will work. |
| warmupThreads | int | 2 | Maximum number of threads for warmup |
| cacheQueries | boolean | True | Should this cache handle caching of incoming queries. If this is false, only warmup queries will be cached. Incoming queries with the "cache=no" argument will never be cached. Incoming queries with the "cache=force:1" argument will override this setting. Incoming queries with the "cache=evict" argument will evict the query from all caches if possible. |
| maxCachedQueries | int | 1000 | Maximum number of queries to cache. Additional queries are evicted using a LRU algorithm. |
| ignoreFromCacheKey | string | cache,user_id,userquery_id,usersession_id | List of url query parameters to ignore from the cache key construction. Separate each field with a come ",". |
| warmupDelayS | int | 10 | Elapsed time in seconds between imports on one of the build group slices, then the warmup starts. |
| Type | Wrapper | Description |
| WarmUpQuery* | - | Queries that will be automatically cached |
| Name | Type | Default value | Description |
| args | string | - | Arguments of the query to autocache, in URL form. For example, q=test%20stuff&logic=sl0 |
| Name | Type | Default value | Description |
| name | string | - | |
| warmupWorkRatio | double | 1.0 | Maximum ratio of time each warm-up thread will work. |
| warmupThreads | int | 2 | Maximum number of threads for warmup |
| cacheQueries | boolean | True | Should this cache handle caching of incoming queries. If this is false, only warmup queries will be cached. Incoming queries with the "cache=no" argument will never be cached. Incoming queries with the "cache=force:1" argument will override this setting. Incoming queries with the "cache=evict" argument will evict the query from all caches if possible. |
| maxCachedQueries | int | 1000 | Maximum number of queries to cache. Additional queries are evicted using a LRU algorithm. |
| ignoreFromCacheKey | string | cache,user_id,userquery_id,usersession_id | List of url query parameters to ignore from the cache key construction. Separate each field with a come ",". |
| expiryTimeS | int | 3600 | Expiry time for queries in the cache |
| Type | Wrapper | Description |
| WarmUpQuery* | - | Queries that will be automatically cached |
| Name | Type | Default value | Description |
| defaultLogic | string | - | Default search logic (can be overriden using API parameters). |
| defaultTarget | string | - | Default search target (can be overriden using API parameters). |
| targetReporting | string | - | Target reporting to use for the search queries. |
| customRunnerFactoryClassId | string | - | |
| maxConcurrentQueries | int | 0 | The maximum number of concurrent queries processed by the search server. If this limit is reached, incoming queries will be queued. 0 means the number of core of the search server times two. |
| maxWaitingQueries | int | 200 | When the maximum number of concurrent queries is reached the queries are put in a queue. This setting configures the maximum length of this queue. When this maximum is reached the query is rejected. |
| base | string | /search-api | HTTP path for this command |
| Type | Wrapper | Description |
| KeyValue* | customRunnerFactoryParams |
| Name | Type | Default value | Description |
| defaultLogic | string | - | Default search logic (can be overriden using API parameters). |
| defaultTarget | string | - | Default search target (can be overriden using API parameters). |
| targetReporting | string | - | Target reporting to use for the search queries. |
| customRunnerFactoryClassId | string | - | |
| maxConcurrentQueries | int | 0 | The maximum number of concurrent queries processed by the search server. If this limit is reached, incoming queries will be queued. 0 means the number of core of the search server times two. |
| maxWaitingQueries | int | 200 | When the maximum number of concurrent queries is reached the queries are put in a queue. This setting configures the maximum length of this queue. When this maximum is reached the query is rejected. |
| base | string | /search-api | HTTP path for this command |
| Type | Wrapper | Description |
| KeyValue* | customRunnerFactoryParams |
| Name | Type | Default value | Description |
| base | string | /search-api | HTTP path for this command |
| Name | Type | Default value | Description |
| base | string | /search-api | HTTP path for this command |
| targetReporting | string | - | |
| tokenizationConfig | string | - | Tokenization config name used to parse the query. |
| autocomplete | boolean | False | Appends suggest results to the last query word being typed in the search field to autocomplete it. It only works with a suggest built with the Subexpr matching or Substring matching build options. |
| recursive | boolean | False | Discards the leftmost word of the query progressively. It sends each new subquery to the suggest(s) until the max number of suggestions is reached, or until there is no more word to use. For example, for a query "A B C", the suggest will be called 3 times, with "A B C", "B C", and "C". |
| Name | Type | Default value | Description |
| base | string | /search-api | HTTP path for this command |
| Name | Type | Default value | Description |
| base | string | /search-api | HTTP path for this command |
| Name | Type | Default value | Description |
| base | string | /search-api | HTTP path for this command |
| queryToPerform | string | q=IsAliveQuery | The isAlive can optionally perform a query to check that all components are
ready. If you want this behavior, enter the search parameters to query for here. For example "q=test&logic=sl0". If this is null, the query won't be performed. |
| targetQueryCommand | string | /search-api | Command path on which the query will be performed. |
| performQuerySynchronously | boolean | False | Should the query be performed synchronously on isAlive call or should it run in a background thread, and cached result be returned. |
| asynchronousQueryDelayS | int | 5 | Elapsed between two queries if the query is performed asynchronously. |
| Name | Type | Default value | Description |
| base | string | /search-api | HTTP path for this command |
| Name | Type | Default value | Description |
| base | string | /search-api | HTTP path for this command |
| defaultLogic | string | - | |
| defaultHighlightPrefixHandlers | string | Comma-separated list of prefix handlers that target the preview for highlight. The default prefix handler is "text". |
|
| defaultHighlightFacetIds | string | Comma-separated list of facets. Refinements on categories are highlighted in the preview if they have a parent category in this attribute. | |
| convertAddresses | string | - | Semicolon separated list of convert instance names or urls to use. |
| Name | Type | Default value | Description |
| base | string | /search-api | HTTP path for this command |
| maxConcurrentComputations | int | 4 | Maximum number of concurrent thumbnail computations. Thumbnail queries that do not require a computation (cache hits) are not considered. |
| defaultWidth | int | 120 | Width of the computed thumbnail, if not specified in request |
| defaultHeight | int | 90 | Height of the computed thumbnail, if not specified in request |
| allowUnsecurePrecomputedThumbnails | boolean | False | When security is enforced on the fetch request, should a precomputed thumbnail
be returned, if any. Security is not enforced on precomputed thumbnails: any logged user knowing the URL of a document could retrieve its precomputed thumbnail. |
| convertAddresses | string | - | Semicolon separated list of convert instance names or urls to use. |
| Type | Wrapper | Description |
| ThumbnailsCache | - | Cache for the thumbnails computed on the fly |
| Name | Type | Default value | Description |
| secure | boolean | True | Thumbnails are only cached and retrieved if enforce_security
is set to false for the request. If false, thumbnails are always cached and retrieved. Warning: any logged user knowing the URL of a document could then retrieve a thumbnail for it. |
| maxHeight | int | 120 | Maximum height of thumbnails for them to be cacheable |
| maxWidth | int | 120 | Maximum width of thumbnails for them to be cacheable |
| memoryEntries | int | 20 | Number of thumbnails to keep in memory cache |
| diskEntries | int | 2000 | Number of thumbnails to keep in disk cache |
| timeToLiveS | int | 7200 | Time period in seconds during which a thumbnail remains in cache. Note that when there is a cache, we also send an expires HTTP header for the thumbnails, with the same time period. |
| Type | Wrapper | Description |
| Suggest* | - | List of Suggest. |
| SuggestDispatcher* | - | List of SuggestDispatcher. |
| Name | Type | Default value | Description |
| suggestName | string | - | The mandatory suggest name. Must match [A-z0-9_]+ |
| whiteListURL | string | - | URL to a suggest-allow list resource |
| blackListURL | string | - | URL to a suggest-block list resource |
| discardComplexQuery | boolean | False | Discards queries containing prefix handlers and operators. |
| applicationId | string | - | Retrieves logs for a specific application. |
| Type | Wrapper | Description |
| SuggestBuildConfig | - | Build options |
| SuggestBuildTrigger | - | Optional build trigger |
| SuggestQueryConfig | - |
| Name | Type | Default value | Description |
| subExpr | boolean | False | Finds matches on every start of word. For example, "first test" will be returned both for "fir" and for "tes". |
| subString | boolean | False | Finds matches on every letter. For example, "first test" will be returned for "fir", for "rs", for "es", ... |
| splitSentence | boolean | False | Breaks up a suggest entry into several entries, and performs matches independently on the chunks. If the entry is multi-sentence, an entry will be created for each sentence. |
| splitNGrams | int | 0 | Breaks up a suggest entry into several entries, and performs matches independently on the chunks. A sliding window of ngrams of a given size will be created, and an entry will be created for each step of the window. For example, "a b c d e f" with a split on 4-grams will give entries "a b c d", "b c d e" and "c d e f". 0 means no splitting. This action is performed after the sentence split if the Sentence split option is selected. |
| computePermutation | boolean | False | Computes all permutations for an entry and adds them as separate entries. This action is performed after the sentence split if the Sentence split option is selected. Note that entries longer than 8 words will not be permuted for performance reasons (would generate n! entries) |
| maxEntryLength | int | 50 | Maximum number of characters in a suggest entry. This is a security measure to prevent overly-long entries. They are automatically truncated after the specified length. 0 means no limit. |
| maxSuggestions | int | 10 | The maximum number of suggestions that can be shown to the user for a given input string. You cannot change this dynamically. |
| nbUrlsPerEntry | int | 3 | Defines the maximum number of URL to be stored for each entry. |
| tokenizationConfig | string | - | Tokenization Config to use. |
| sanitizeEntries | boolean | False | Strips the entry of punctuation, and encloses any UQL operator between quotes. |
| buildAfterIndexImport | boolean | False | Triggers a build automatically after the index refreshes. |
| secure (UI: Enable security) |
boolean | False | Makes use of documents and users' security tokens to restrict suggestions. |
| securityModel (UI: Security model) |
enum(default, enovia) | default | Enables the enovia-specific handling of security tokens. |
| Name | Type | Default value | Description |
| startTimestamp | long | - | Unix timestamp |
| endTimestamp | long | - | Unix timestamp |
| repeatInterval | long | - | Repeat interval in milliseconds |
| Name | Type | Default value | Description |
| startTimestamp | long | - | Unix timestamp |
| endTimestamp | long | - | Unix timestamp |
| cronExpression | string | - | Quartz Cron expression: seconds minutes hours day_of_month month day of week [year] |
| Name | Type | Default value | Description |
| distance | int | 2 | Allows approximate matching. The higher the distance the more approximate the match. 0 for exact match. |
| minLengthForDistance1 | int | 3 | Only searches for distance 1 fuzzy matches if the original word in the query is at least N characters long. This avoids too much approximation on very short words. The default value is 3. |
| minLengthForDistance2 | int | 6 | Only searches for distance 2 fuzzy matches if the original word in the query is at least N characters long. This avoids too much approximation on very short words. The default value is 6. |
| autocomplete | boolean | False | Only works with a suggest built with subString or subExpr options. If set, the query is not replaced by the suggest results, instead, the results are appended to the query being typed in order to auto complete it. |
| recursive | boolean | False | Discards the leftmost word of the query progressively. Each new subquery, is sent to the suggest(s), until maxSuggestions is reached, or until there is no more word to use. For example, for a query "A B C", the suggests will be called 3 times, with "A B C", "B C", and "C". |
| secureSuggestTimeoutMS | int | 200 | Aborts matching in a secure suggest when this time limit is reached. |
| Name | Type | Default value | Description |
| logic | string | - | The search logic to use |
| target | string | - | The search target to use |
| indexField | string | - | The index field to retrieve |
| query | string | #all | The query: may be used as a filter for the exported index data |
| searchServerInstance | string | - | The search server instance to target |
| suggestName | string | - | The mandatory suggest name. Must match [A-z0-9_]+ |
| whiteListURL | string | - | URL to a suggest-allow list resource |
| blackListURL | string | - | URL to a suggest-block list resource |
| Type | Wrapper | Description |
| SuggestBuildConfig | - | Build options |
| SuggestBuildTrigger | - | Optional build trigger |
| SuggestQueryConfig | - |
| Name | Type | Default value | Description |
| logic | string | - | The search logic to use |
| target | string | - | The search target to use |
| indexField | string | - | The index field to retrieve |
| query | string | #all | The query: may be used as a filter for the exported index data |
| searchServerInstance | string | - | The search server instance to target |
| suggestName | string | - | The mandatory suggest name. Must match [A-z0-9_]+ |
| whiteListURL | string | - | URL to a suggest-allow list resource |
| blackListURL | string | - | URL to a suggest-block list resource |
| mode | enum(all, exact, prefix, suffix, regexp) | all | Matching mode. If 'all' is selected, all the content of the index field will be used. |
| pattern | string | - | The string to look for. |
| keepContext | boolean | True | When set to True, the context is kept in suggest entry. |
| Type | Wrapper | Description |
| SuggestBuildConfig | - | Build options |
| SuggestBuildTrigger | - | Optional build trigger |
| SuggestQueryConfig | - |
| Name | Type | Default value | Description |
| mode | enum(all, exact, prefix, suffix, regexp) | all | Matching mode. If 'all' is selected, all the content of the index field will be used. |
| pattern | string | - | The string to look for. |
| keepContext | boolean | True | When set to True, the context is kept in suggest entry. |
| logic | string | - | The search logic to use |
| target | string | - | The search target to use |
| indexField | string | - | The index field to retrieve |
| query | string | #all | The query: may be used as a filter for the exported index data |
| searchServerInstance | string | - | The search server instance to target |
| suggestName | string | - | The mandatory suggest name. Must match [A-z0-9_]+ |
| whiteListURL | string | - | URL to a suggest-allow list resource |
| blackListURL | string | - | URL to a suggest-block list resource |
| mxentryQuery | string | availability:aclfts | This query retrieves mxov, mxentry and mxpass. |
| securityTokensMeta | string | mxov | Meta associated to each suggest entry used as base for security token computing. |
| Type | Wrapper | Description |
| SuggestBuildConfig | - | Build options |
| SuggestBuildTrigger | - | Optional build trigger |
| SuggestQueryConfig | - |
| Name | Type | Default value | Description |
| logic | string | - | The search logic to use |
| target | string | - | The search target to use |
| indexField | string | - | The index field to retrieve |
| query | string | #all | The query: may be used as a filter for the exported index data |
| searchServerInstance | string | - | The search server instance to target |
| suggestName | string | - | The mandatory suggest name. Must match [A-z0-9_]+ |
| whiteListURL | string | - | URL to a suggest-allow list resource |
| blackListURL | string | - | URL to a suggest-block list resource |
| dictionaryName | string | dict0 |
| Type | Wrapper | Description |
| SuggestBuildConfig | - | Build options |
| SuggestBuildTrigger | - | Optional build trigger |
| SuggestQueryConfig | - |
| Name | Type | Default value | Description |
| logic | string | - | The search logic to use |
| target | string | - | The search target to use |
| indexField | string | - | The index field to retrieve |
| query | string | #all | The query: may be used as a filter for the exported index data |
| searchServerInstance | string | - | The search server instance to target |
| suggestName | string | - | The mandatory suggest name. Must match [A-z0-9_]+ |
| whiteListURL | string | - | URL to a suggest-allow list resource |
| blackListURL | string | - | URL to a suggest-block list resource |
| meta | string | - | The CSV encoded meta to retrieve |
| Type | Wrapper | Description |
| SuggestBuildConfig | - | Build options |
| SuggestBuildTrigger | - | Optional build trigger |
| SuggestQueryConfig | - |
| Name | Type | Default value | Description |
| root | string | - | Path to retrieve |
| rootForm | enum(exact, lowercase, normalized) | normalized | Form of the category root. |
| logic | string | - | The search logic to use |
| target | string | - | The search target to use |
| indexField | string | - | The index field to retrieve |
| query | string | #all | The query: may be used as a filter for the exported index data |
| searchServerInstance | string | - | The search server instance to target |
| suggestName | string | - | The mandatory suggest name. Must match [A-z0-9_]+ |
| whiteListURL | string | - | URL to a suggest-allow list resource |
| blackListURL | string | - | URL to a suggest-block list resource |
| Type | Wrapper | Description |
| SuggestBuildConfig | - | Build options |
| SuggestBuildTrigger | - | Optional build trigger |
| SuggestQueryConfig | - |
| Name | Type | Default value | Description |
| root | string | - | Path to retrieve |
| rootForm | enum(exact, lowercase, normalized) | normalized | Form of the category root. |
| logic | string | - | The search logic to use |
| target | string | - | The search target to use |
| indexField | string | - | The index field to retrieve |
| query | string | #all | The query: may be used as a filter for the exported index data |
| searchServerInstance | string | - | The search server instance to target |
| suggestName | string | - | The mandatory suggest name. Must match [A-z0-9_]+ |
| whiteListURL | string | - | URL to a suggest-allow list resource |
| blackListURL | string | - | URL to a suggest-block list resource |
| removeRoot | boolean | False | Removes the category root from results. |
| Type | Wrapper | Description |
| SuggestBuildConfig | - | Build options |
| SuggestBuildTrigger | - | Optional build trigger |
| SuggestQueryConfig | - |
| Name | Type | Default value | Description |
| suggestName | string | - | The mandatory suggest name. Must match [A-z0-9_]+ |
| whiteListURL | string | - | URL to a suggest-allow list resource |
| blackListURL | string | - | URL to a suggest-block list resource |
| url | string | - | URL to the Suggest XML file. |
| tokenizationConfig | string | - | Tokenization Config to use. |
| Type | Wrapper | Description |
| SuggestQueryConfig | - |
| Name | Type | Default value | Description |
| suggestName | string | - | The mandatory suggest name. Must match [A-z0-9_]+ |
| whiteListURL | string | - | URL to a suggest-allow list resource |
| blackListURL | string | - | URL to a suggest-block list resource |
| url | string | - | URL to the directory where the compiled suggest data is stored. |
| tokenizationConfig | string | - | Tokenization Config to use. |
| Type | Wrapper | Description |
| SuggestQueryConfig | - |
| Name | Type | Default value | Description |
| name | string | - | The mandatory suggest dispatcher name. Must match [A-z0-9_]+ |
| matchWholeQuery | boolean | False | Sends the whole query to the default suggest if the cursor is outside a prefix handler. If unselected, it sends a subquery delimited by surrounding prefixes. |
| useWithUnknownPrefix | boolean | False | Sends the query to the default suggest if the cursor is within an undefined prefix handler. If unselected, undefined prefix handlers are ignored and there will be no suggestions. |
| addQuotes | boolean | True | Adds quotes where necessary so that the whole suggestion is included in the prefix handler. |
| displayPrefixInSuggest | boolean | False | When activated, the suggest is prefixed by the corresponding prefix handler if defined. |
| maxNbResults | int | 0 | Max number of suggest entries returned by this suggest dispatcher (0 returns all available entries). |
| boostVariety | boolean | False | Allows to retrieve the best matches for each suggest according to the maximum number of suggestions. Note that this mode does not always return the best global results. |
| Type | Wrapper | Description |
| StringValue* | designedForLogics | SearchLogic names. Prefix handler names will be checked against these logics |
| PrefixHandlerSuggestPair* | - | Association of a prefix handler and a suggest |
| Name | Type | Default value | Description |
| prefixHandler | string | - | A prefix handler name or alias |
| suggestName | string | - | An existing suggest name |
| maxNbResults | int | 0 | Max number of suggest entries returned by this suggest |
| useInDefaultSuggest | boolean | False | Select Default to specify the suggest dictionary to use by default for a specific prefix handler. Note that you must specify at least one default suggest to use the following options:
|
| Name | Type | Default value | Description |
| version | long | - | - |
| enableTimeBasedLogRotation | boolean | False | Rotates process log files each day at midnight. |
| logRotationCronExpression | string | - | Custom Quartz Cron expression to trigger log rotation. Only taken into account if enableTimeBasedLogRotation is false. |
| logRotationMaxSizeKB | long | - | If set, process log files are rotated when bigger than the specified number of kilobytes. |
| logPurgeMaxSizeKB | long | - | If set, process log files are purged (older first) when their total size is above the specified number. |
| logExpirationDays | long | - | If set, process log files are purged when older than the specified number of days. |
| logInSyslog | boolean | False | If set, log are also copied in syslog with
type=daemon, ident=cloudview, message="AppenderName: logMessage" This producs this type of line in /var/log/daemon.log: "Mar 19 12:10:47 madpc125 cloudview: index.clustermanager: Building slice list for st0" |
| Type | Wrapper | Description |
| GlobalLoggerConfig | - | |
| LoggingLevel* | - |
| Name | Type | Default value | Description |
| maxSize | int | 100 | Max size of the RAM buffer that stores latest messages. |
| enableGlobalLogEntryStore | boolean | False | Keeps all logs (in these case, an additional structure is created on disk and GetGlobalLogEntryList can be called). |
| Name | Type | Default value | Description |
| level | string | - | Logging level. The following values are available:
off,
fatal,
error,
warning,
info,
notice,
debug, and
trace.
|
| host | string | - | Host for which this logging level should be applied. If null, the configuration applies to every host of the cluster. |
| install | string | - | Instance for which this logging level should be applied. If null, the configuration applies to every instance of the cluster. |
| process | string | - | Process for which this logging level should be applied. If null, the configuration applies to every process of the selected host (or every host if host is null).
|
| logger | string | - | Logger for which this logging level should be applied. If null, the configuration applies to every logger. |
| Name | Type | Default value | Description |
| level | string | - | Logging level. The following values are available:
off,
fatal,
error,
warning,
info,
notice,
debug, and
trace.
|
| host | string | - | Host for which this logging level should be applied. If null, the configuration applies to every host of the cluster. |
| install | string | - | Instance for which this logging level should be applied. If null, the configuration applies to every instance of the cluster. |
| process | string | - | Process for which this logging level should be applied. If null, the configuration applies to every process of the selected host (or every host if host is null).
|
| logger | string | - | Logger for which this logging level should be applied. If null, the configuration applies to every logger. |
| Name | Type | Default value | Description |
| httpProxyHost | string | - | Address of the HTTP proxy to send usage data report and diagnostics to Exalead |
| httpProxyPort | int | - | Port of the HTTP proxy to send usage data report and diagnostics to Exalead |
| httpProxyLogin | string | - | Login of the HTTP proxy to send usage data report and diagnostics to Exalead |
| httpProxyPassword | string | - | Password of the HTTP proxy to send usage data report and diagnostics to Exalead |
| Type | Wrapper | Description |
| CustomReportField* | - | |
| NotificationsConfig | - | |
| PerformanceMonitoringConfig | - | |
| SearchDynamicReportingConfig | - | |
| SearchStaticReportingConfig | - | |
| ServiceReportingConfig | - | |
| UsageDataReportConfig | - |
| Name | Type | Default value | Description |
| fieldName | string | - | |
| headerName | string | - |
| Name | Type | Default value | Description |
| fieldName | string | - | |
| paramName | string | - |
| Name | Type | Default value | Description |
| enabled | boolean | True | |
| licenseNotificationEnabled | boolean | True | |
| processesNotificationEnabled | boolean | True | |
| indexingNotificationEnabled | boolean | True | |
| searchNotificationEnabled | boolean | True | |
| tokenNotificatioEnabled | boolean | True | |
| tokenNotificationThreshold | double | 0.8 | |
| sender | string | - | |
| recipient | string | - | |
| subjectPrefix | string | [CloudView] |
| Type | Wrapper | Description |
| SMTPServer | - |
| Name | Type | Default value | Description |
| username | string | - | Username used to connect to the SMTP server. |
| password | string | - | Password associated to the username. |
| host | string | localhost | Hostname of the SMTP server. |
| port | int | 25 | Port of the targeted SMTP server. |
| tls | boolean | False | Enables the TLS (Transport Layer Security) protocol for this server. |
| Name | Type | Default value | Description |
| monitoringIntervalS | int | 60 | Interval in seconds between two monitoring probes. Value must be higher or equal to 4 |
| timeout | int | 20 | Timeout value in seconds for network activity |
| collectorThreads | int | 6 | |
| enabled | boolean | True | Enables monitoring |
| rrddir | string | ${dataDir}/perfmonitoring/probe | Directory where probes files (rrd) are stored. |
| configdir | string | ${dataDir}/perfmonitoring/config | Directory parsed to find xml configuration files. |
| tmpdir | string | ${dataDir}/perfmonitoring/tmp | Temporary directory used internally. |
| libspath | string | ${installDir}/extrajava/jrds/ | List of jar files or directory containing probes. |
| autocreate | boolean | True | Enables the auto-creation of configdir and rrddir. |
| onlyForInstallName | string | If set, restricts monitoring to a specific install name. |
| Type | Wrapper | Description |
| StringValue* | monitoredPageCaches | List of PageCache to monitor. |
| MonitoredHost* | - | Additional host probes |
| MonitoredIndexField* | - | List of index field to monitor. |
| MonitoredIndexFieldConfig | - | Global index fied monitoring config |
| PerformanceMonitoringTimer* | - | Additional timers |
| Name | Type | Default value | Description |
| name | string | - |
| Type | Wrapper | Description |
| MonitoredHostConnection* | - | |
| MonitoredHostProbe* | - |
| Name | Type | Default value | Description |
| type | string | - | Connection type. Must not be empty. |
| name | string | - | Connection name. Must not be empty. |
| Type | Wrapper | Description |
| MonitoredHostElementArg* | - | List of arguments for connection. Currently unused. |
| Name | Type | Default value | Description |
| type | string | - | |
| value | string | - |
| Name | Type | Default value | Description |
| type | string | - | The probe type |
| label | string | - | The descriptive label of the probe |
| connection | string | - | The name of the MonitoredHostConnection used by the probe. |
| Type | Wrapper | Description |
| MonitoredHostElementArg* | argList | The list of MonitoredHostElementArg (one per argument of the probe) |
| MonitoredHostElementArg* | - | The list of MonitoredHostElementArg (one per argument of the probe). |
| Name | Type | Default value | Description |
| name | string | - |
| Name | Type | Default value | Description |
| monitorAllFacetFields | boolean | True | If true, monitor all the Value and Category fields |
| Name | Type | Default value | Description |
| monitoringIntervalS | int | 60 | Interval in seconds between two monitoring probes. Value must be higher or equal to 4 |
| timeout | int | 20 | Timeout value in seconds for network activity |
| collectorThreads | int | 6 | |
| name | string | - | Identifier name of the timer |
| Type | Wrapper | Description |
| StringValue* | probeTypes | List of probe types using this timer. Probe types that are not referenced by any timer use the default one. |
| Name | Type | Default value | Description |
| enabled | boolean | False | Enables automatic report generations |
| Type | Wrapper | Description |
| SearchDynamicReportingConfigNames | - | Generated reporting configuration element names. |
| Name | Type | Default value | Description |
| hostName | string | - | |
| installName | string | - | |
| papiPort | int | - | |
| reportingConnector | string | - | |
| reportingBuildGroup | string | - | |
| reportingDataModel | string | - | |
| reportingTaskQueue | string | - | |
| reportingIndexBuilder | string | - | |
| reportingSearchTarget | string | - | |
| reportingSearchLogic | string | - |
| Name | Type | Default value | Description |
| enabled | boolean | True | Enables automatic report generations |
| reportCron | string | - | Quartz Cron expression triggering global static report generation. |
| reportApplicationCron | string | 0 10 0 * * ? | Quartz Cron expression triggering static report generation on applications. The default setting is every day at 00:10. Reports are generated for each deployed application. |
| topLimit | int | 100 | Maximum number of rows to retrieve while computing ordered results (for example, top queries). |
| maxVersionsToKeep | int | 30 | Maximum number of resource versions to keep in the StaticReportList. 0 means no limit is enforced, whereas 1 will keep only the most recent version. |
| Type | Wrapper | Description |
| ApplicationReportScheduling* | - | List of application reports scheduling. Each application can have a scheduled search static reporting. Each application report scheduling is defined by the application id and a Quartz Cron expression. |
| Name | Type | Default value | Description |
| cron | string | - | |
| applicationId | string | - |
| Type | Wrapper | Description |
| ReporterConfig* | - |
| Name | Type | Default value | Description |
| name | string | - |
| Type | Wrapper | Description |
| ReportingPublisher* | - |
| Name | Type | Default value | Description |
| synchronous | boolean | False | |
| closeTimeoutMS | int | 0 | |
| batchTimeoutMS | int | 1000 | |
| minBatchSize | int | 50 | |
| maxBatchSize | int | 250 | |
| maxQueueSize | int | 250 | |
| publishedFields | string | - | |
| host | string | - | Hostname of the reporting publisher |
| port | int | - | Port of the reporting publisher |
| connectorName | string | - | Name of the reporting publisher |
| Name | Type | Default value | Description |
| synchronous | boolean | False | |
| closeTimeoutMS | int | 0 | |
| batchTimeoutMS | int | 1000 | |
| minBatchSize | int | 50 | |
| maxBatchSize | int | 250 | |
| maxQueueSize | int | 250 | |
| publishedFields | string | - | |
| file | string | - | |
| maxFileSizeMB | int | 50 | 0 means no rotation is triggered by the file size |
| rotateEveryNMonths | int | - | 0 means no rotation is triggered by the file age in month |
| rotateEveryNDays | int | 1 | 0 means no rotation is triggered by the file age in day |
| rotateEveryNHours | int | - | 0 means no rotation is triggered by the file age in hour |
| maxSizeToKeepMB | int | 2500 | Maximum csv reporting files volume in megaoctet. The oldest files are discarded at rotation time. 0 means no limit is enforced. |
| maxFileToKeep | int | 50 | Maximum csv reporting files to keep. The oldest files are discarded at rotation time. 0 means no limit is enforced, whereas 1 will discards all rotated files. |
| maxDayToKeep | int | 30 | Maximum csv reporting file age in day to keep. The oldest files are discarded at rotation time. 0 means no limit is enforced, whereas 1 only keep todays files. |
| Name | Type | Default value | Description |
| synchronous | boolean | False | |
| closeTimeoutMS | int | 0 | |
| batchTimeoutMS | int | 1000 | |
| minBatchSize | int | 50 | |
| maxBatchSize | int | 250 | |
| maxQueueSize | int | 250 | |
| publishedFields | string | - | |
| driver | string | - | JDBC driver fully qualified Java class name. |
| connectionString | string | - | JDBC connection string. This is vendor specific. |
| login | string | - | Login for the database connection. |
| password | string | - | Password for the database connection. |
| table | string | - | Table where data must be inserted. |
| insertQuery | string | - | Query used to insert data in the table. |
| Name | Type | Default value | Description |
| synchronous | boolean | False | |
| closeTimeoutMS | int | 0 | |
| batchTimeoutMS | int | 1000 | |
| minBatchSize | int | 50 | |
| maxBatchSize | int | 250 | |
| maxQueueSize | int | 250 | |
| publishedFields | string | - | |
| schema | string | - | |
| rotationCron | string | 0 0 0 * * ? | Quartz Cron expression to force a rotation. A rotation is also triggered every time a collection is queried. |
| maxRowCount | long | 100000 | Maximum count of line in the database. When this size is reached the oldest records are discarded. 0 means there is no limit to the database size. |
| Name | Type | Default value | Description |
| enabled | boolean | False | Should usage data be sent regularly to 3DS EXALEAD? |
| Name | Type | Default value | Description |
| version | long | - | - |
| description | string | - | A descriptive name for this deployment, that will appear in the Admin-UI, for identification purposes |
| hostAgentPort | int | - | Default port for the hostagent if not defined in each host |
| Type | Wrapper | Description |
| Host* | - | - |
| PortRange | - | - |
| VirtualService* | - | - |
| Name | Type | Default value | Description |
| hostname | string | - | Network name of the physical host. The host must be reachable by all other hosts of the CloudView install using this name. |
| install | string | - | Name of this CloudView cluster host on the physical host. It is possible to deploy several CloudView installs in the same CloudView cluster on the same physical host. |
| architecture | string | - | System architecture of the host. Optional. |
| hostAgentPort | int | - | Fixed Host agent port (optional). Overrides hostAgentPort set in DeploymentConfig |
| Name | Type | Default value | Description |
| startPort | int | - | First TCP port |
| lastPort | int | - | Last TCP port |
| Name | Type | Default value | Description |
| name | string | - | $CONSTRAINTS |
| Type | Wrapper | Description |
| RoleAttribute* | - | - |
| Name | Type | Default value | Description |
| name | string | - | Name of the virtual service (use in Directory.dispatch(...). |
| Type | Wrapper | Description |
| VirtualServiceGroupRef* | - | - |
| VirtualServiceRef* | - | - |
| Name | Type | Default value | Description |
| name | string | - | - |
| service | string | - | Name of the service which is virtualized |
| Name | Type | Default value | Description |
| name | string | - | Fully qualified path to the service implementation. |
| enabled | boolean | true | Use this to easily enable or disable. |
| power | int | 1 | - |
| maxConnection | int | 100 | - |
| Name | Type | Default value | Description |
| enableServiceList | boolean | true | Enable services listing on Java processes |
| version | long | - | - |
| collapseIndexSlices | boolean | True | Merges the processes for all slices (in a given index replica) into only one process. |
| collapseSearchServers | boolean | False | Merges searchserver processes in the gateway process. |
| collapseMaster | boolean | False | Merges the Exascript master process into the hostagent. |
| debug | boolean | False | Activate debugger access on java process. |
| Type | Wrapper | Description |
| KeyValue* | globalBeegistryKeys | Additional global beegistry keys |
| ProcessInternalConfig* | - | Configuration sets for the process. Configuration are matched in a first-match fashion. For example: <ProcessInternalConfig name="foobar" runtime="java" /> <ProcessInternalConfig runtime="java" /> the second one will be used for all java processes except foobar. |
| SearchInternalParameters | - | |
| ServerCiphers | - | Defines the cipher suite by a sequence on include and exclude statement. |
| ServerCryptographicProtocols | - | Set the protocol that will be supported by servers (SSL, TLS..., see javax.net.ssl.SSLEngine) |
| TickInternalParameters | - |
| Name | Type | Default value | Description |
| name | string | - | Name of the process on which this applies. Applies to all processes if null |
| hostname | string | - | Name of the host on which this applies. Applies to all hosts if null |
| installName | string | - | Name of the install on which this applies. Applies to all installs if null |
| runtime | string | - | Runtime on which this applies. One of exa, java, dotnet. Applies to all runtimes if null |
| exaBinary | string | - | EXA binary to use in case of an EXA process. |
| httpMinThreads | int | 5 | Minimum number of alive threads for servicing HTTP queries |
| httpMaxThreads | int | 500 | Maximum number of alive threads for servicing HTTP queries |
| httpMaxStopTime | int | 100 | Maximum total time(s) allowed for current queries to be treated before really stopping the server |
| httpMaxGETQuerySize | int | 32768 | Default max size in bytes of HTTP GET queries on this process. Note that this might be overriden by specific settings (like the SearchAPI max size) |
| httpMaxFormPOSTQuerySize | int | 10000000 | Default max size in bytes of HTTP POST queries on this process. Note that this might be overriden by specific settings (like the SearchAPI max size) |
| httpMaxIdleTimeMS | int | 86400000 | Maximum timeout for an HTTP connection, either while waiting for new data, or while processing a query |
| httpAcceptorThreads | int | 1 | Number of threads waiting for new HTTP connections |
| httpAcceptQueueSize | int | 1200 | Maximum size for the TCP acception queue |
| Type | Wrapper | Description |
| KeyValue* | params | Various advanced process params:
|
| StringValue* | args | Command line arguments. If empty, default arguments are used. List of possible params for java processes:
For linux:
|
| KeyValue* | envOverride | Environment variables to set/replace for this process |
| KeyValue* | envAppend | Additional content to append at the end of environment variables (for PATH-like variables) |
| KeyValue* | envPrepend | Additional content to prepend at the beginning of environment variables (for PATH-like variables) |
| Name | Type | Default value | Description |
| fullHitsContextMaxLifeSpan | int | 1000 | When fullhits and their associated metas are released, they are put back into a memory pool for reuse. A full free is performed each 'fullHitsContextMaxLifeSpan' queries. |
| rankedSearchFullHitsRecyclingMaxSize | int | 500 | When fullhits are released, they are put back into a memory pool for reuse. A full free is performed once the pool has allocated more than 'rankedSearchFullHitsRecyclingMaxSize' fullhits. |
| fullHitMetasRecyclingMaxSize | int | 50000 | When fullhit metas are released, they are put back into a memory pool for reuse. A full free is performed once the pool has allocated more than 'fullHitMetasRecyclingMaxSize' metas. |
| messagesAllocatorMaxSizeMB | int | 2000 | A full reinitialization of the FLEA messages allocator will be performed once the pool of flea message has allocated more than 'messagesAllocatorMaxSizeMB' bytes. |
| messagesAllocatorMaxLifeSpan | int | 1000 | A full reinitialization of the FLEA messages allocator will be performed once 'messagesAllocatorMaxLifeSpan' queries have been done. |
| workerThreadMaxQueries | int | 100 | A worker (query container at slice level) is entirely destroyed once a worker thread has served 'workerThreadMaxQueries' queries. |
| runnerMaxLifeSpan | int | 300 | A runner (query container at searchserver level) is entirely destroyed once a runner has served queries during 'runnerMaxLifeSpan' seconds. |
| runnerMaxQueries | int | 1000 | A runner is entirely destroyed once a runner has served 'runnerMaxQueries' queries. |
| runnerKeepAtLeastWhenIdle | int | 0 | Keep at least 'runnerKeepAtLeastWhenIdle' runner(s) ready to serve queries even without traffic. |
| runnerKeepAtLeastWhenInBurst | int | 5 | Be sure you keep at least 'runnerKeepAtLeastWhenInBurst' live runners, whatever the fullfilment of 'runnerMaxQueries' 'runnerMaxLifeSpan' when your are in a peak of activity. |
| runnerDestroyIdleAfter | int | 60 | Destroy idle runners after 'runnerDestroyIdleAfter' seconds of inactivity. |
| Name | Type | Default value | Description |
| name | string | - |
| Name | Type | Default value | Description |
| name | string | - |
| Type | Wrapper | Description |
| ExcludeProtocol* | - | Name of a crypograhic protocol as defined in javax.net.ssl.SSLEngine) to exclude |
| IncludeProtocol* | - | Name of a crypograhic protocol (as defined in javax.net.ssl.SSLEngine) to include |
| Name | Type | Default value | Description |
| name | string | - |
| Name | Type | Default value | Description |
| name | string | - |
| Name | Type | Default value | Description |
| bufferRecyclingMaxSize | int | 1000 | When a tick message is released, it is put back into a memory pool for reuse. The attached payload is kept if its size is smaller than bufferRecyclingMaxSize, and freed if larger. |
| bufferRecyclingMaxLifeSpan | int | 64 | To avoid a tick message pool full of messages with a large payload (==bufferRecyclingMaxSize), the payload is released every time the message has been used bufferRecyclingMaxLifeSpan times. |
| Type | Wrapper | Description |
| KeyValue* | params | Parameters added to the global beegistry |
| ProcessConfig* | - | - |
| Name | Type | Default value | Description |
| name | string | - | Process name. Referenced by the attribute "process" of a "Process\ role. |
| Type | Wrapper | Description |
| JavaWebApp* | - | - |
| Name | Type | Default value | Description |
| name | string | - | Name of this webapp |
| url | string | - | Webapp location (WAR file or directory) |
| webAppLoaderClassId | string | - | Custom code for overloading the default webapp classloader |
| extraClassPath | string | - | Elements to add to the webapp class path, additionally to the default CloudView libraries.
extraClassPath is a comma-separated list of elements. Each element must be one of:
|
| isGlobal | boolean | true | Global applications are deployed under the context path "/name". Not global applications are deployed under "/name/hostname-installname/processname". Note that global applications can not expose any service |
| Type | Wrapper | Description |
| KeyValue* | initParams | Webapp init parameters |
| JavaWebAppService* | - | - |
| Name | Type | Default value | Description |
| name | string | - | Name of the service (relative path) in the web app. |
| schemaName | string | - | Optional schema name when published in the directory |
| Name | Type | Default value | Description |
| name | string | - | Process name. Referenced by the attribute "process" of a "Process\ role. |
| Type | Wrapper | Description |
| KeyValue* | params | Parameters added to the process local configuration registry. |
| ConfigFile* | - | - |
| JavaServer* | - | - |
| JavaService* | - | - |
| JavaWebApp* | - | - |
| Name | Type | Default value | Description |
| url | string | - | - |
| extraClassPath | string | - | Extra class path elements to add to the context class loader when loading this
configuration file. Follows the JavaWebApp.extraClassPath syntax. This class path will be used to load the Java objects that might be contained in this configuration file |
| Name | Type | Default value | Description |
| name | string | - | Server name |
| protocol | string | - | Server protocol |
| Type | Wrapper | Description |
| JavaService* | - | List of services deployed in this server |
| JavaWebApp* | - | List of web apps deployed in this server |
| Name | Type | Default value | Description |
| name | string | - | Service name. Exposed full prefix name will be automatically prefixed |
| schemaName | string | - | Optional schema name used when publishing the directory |
| beeKey | string | - | service implementation |
| type | string | - | service type |
| publicName | string | - | Optional public name. If null, name + host + processName is used |
| extraClassPath | string | - | Extra class path elements to add to the context class loader when performing queries on this service. Follows the JavaWebApp.extraClassPath syntax. |
| Name | Type | Default value | Description |
| name | string | - | Process name. Referenced by the attribute "process" of a "Process\ role. |
| Name | Type | Default value | Description |
| name | string | - | Process name. Referenced by the attribute "process" of a "Process\ role. |
| Type | Wrapper | Description |
| KeyValue* | params | Parameters added to the process local configuration registry. |
| ConfigFile* | - | - |
| ExaServer* | - | - |
| ExaService* | - | - |
| Name | Type | Default value | Description |
| name | string | - | - |
| protocol | string | - | - |
| Type | Wrapper | Description |
| ExaService* | - | - |
| Name | Type | Default value | Description |
| name | string | - | - |
| schemaName | string | - | - |
| beeKey | string | - | - |
| type | string | - | - |
| publicName | string | - | Optional public name. If null, name + host + processName is used |
| Type | Wrapper | Description |
| TokenizationConfig* | - |
| Name | Type | Default value | Description |
| name | string | - | The tokenization configuration's name. |
| Type | Wrapper | Description |
| FormIndexingConfig | - | How to index different word forms (exact, normalized, lemmatized) for each language. |
| NormalizerConfig | - | How to normalize words. |
| Tokenizer* | - | List of enabled tokenizers. Tokenizer choice depends on the document's language. |
| Name | Type | Default value | Description |
| tag | string | - | |
| indexKind | short | - | |
| trustLevel | int | 100 |
| Name | Type | Default value | Description |
| transliteration | boolean | True | When normalizing, convert some characters to their latin equivalent |
| useNormalizationExceptions | boolean | True | Uses the normalization exceptions, even if the resource path is not set (in that case, the default resource is used). |
| normalizationExceptionsDir | string | - | The path to the normalization-exceptions resource directory. Use the default resource if no path is set. |
| disableBasisTechNormalizerForLanguages | string | - | Removes BasisTech's processor "Encoding and Character Normalizer" for these languages. |
| enableBasisTechNormalizerForLanguages | string | ja | Adds BasisTech's processor "Encoding and Character Normalizer" only for these languages. |
| useGermanExceptions | boolean | False |
| Type | Wrapper | Description |
| NormalizerCharOverride* | - | |
| NormalizerIndexLower* | - |
| Name | Type | Default value | Description |
| chr | string | - | |
| replace | string | - | |
| language | iso code | - |
| Name | Type | Default value | Description |
| word | string | - | |
| language | iso code | - |
| Name | Type | Default value | Description |
| language | iso code | - | The language handled by this tokenizer. This can be null for all unhandled languages. |
| concatAlphaNum | boolean | True | Concat alpha and num chars |
| concatNumAlpha | boolean | True | Concat num and alpha chars |
| Type | Wrapper | Description |
| StandardTokenizerOverride* | charOverrides | Set of rules that allows the forcing of a type for specific character or for a character set defined by a unicode property. |
| StandardTokenizerOverride* | patternOverrides | Set of rules that allows the forcing of specific regexp type. |
| TokenizerPlugin* | - |
| Name | Type | Default value | Description |
| languages | string | en,de,fr,sv,es,it,nl,pt,no,fi,da,bg,ca,cs,el,hr,hu,pl,ru,sk,sl,sr | Postprocesses BasisTech's analyzer output in order to generate a tokenization as close as possible to that of this standard tokenizer for these languages. |
| Name | Type | Default value | Description |
| resourceDir | string | - | URL for the resource (data://, file;// or resource://) if null, use standard resource of product. |
| Name | Type | Default value | Description |
| resourceDir | string | - | URL for the resource (data://, file;// or resource://) if null, use standard resource of product. |
| Name | Type | Default value | Description |
| resourceDir | string | - | URL for the resource (data://, file;// or resource://) if null, use standard resource of product. |
| Name | Type | Default value | Description |
| resourceDir | string | - | URL for the resource (data://, file;// or resource://) if null, use standard resource of product. |
| addSimplified | boolean | False | Annotates each token with its simplified Chinese transliteration, when applicable. |
| addNGrams | boolean | False | Annotates with NGrams |
| minNGramLength | int | 1 | Minimum length of NGrams (1: monograms, 2: bigrams...) |
| maxNGramLength | int | 2 | Maximum length of NGrams (1: monograms, 2: bigrams...) |
| Name | Type | Default value | Description |
| resourceDir | string | - | URL for the resource (data://, file;// or resource://) if null, use standard resource of product. |
| processRomaji | boolean | False | Processes romaji tokens |
| addRomaji | boolean | False | Annotates each token with its romaji transliteration, when applicable. |
| addCharset | boolean | False | Annotates with charset |
| addNGrams | boolean | False | Annotates with NGrams |
| minNGramLength | int | 1 | Minimum length of NGrams (1: monograms, 2: bigrams...) |
| maxNGramLength | int | 2 | Maximum length of NGrams (1: monograms, 2: bigrams...) |
| addTransliterations | boolean | False | Annotates with transliterations (kanji, katakana, hiragana, romaji). |
| addPartOfSpeech | boolean | False | Annotates with part of speech. |
| Name | Type | Default value | Description |
| type | enum(token, separator, sentence, ignore, punct) | token | Values = "token", "separator", "sentence" (will break related terms extraction, named entities, ...), "ignore" or "punct" (sentence is considered as a separator but it is also considered as an entity separator for semantic extractors) |
| toOverride | string | - |
| Name | Type | Default value | Description |
| type | enum(token, separator, sentence, ignore, punct) | token | Values = "token", "separator", "sentence" (will break related terms extraction, named entities, ...), "ignore" or "punct" (sentence is considered as a separator but it is also considered as an entity separator for semantic extractors) |
| toOverride | string | - | |
| separated | boolean | True | Pattern must be separated to match. |
| Name | Type | Default value | Description |
| addSimplified | boolean | False | Annotates each token with its simplified Chinese transliteration, when applicable. |
| resourceDir | string | - | URL for the resource (data://, file;// or resource://) if null, use standard resource of product. |
| Name | Type | Default value | Description |
| addRomanji | boolean | False | Annotates each token with its romaji transliteration, when applicable. |
| addMorphology | boolean | False | Annotates each token with its part of speech, when applicable. |
| resourceDir | string | - | URL for the resource (data://, file;// or resource://) if null, use standard resource of product. |
| favor | enum(precision, recall) | recall | Favoring precision decreases the amount of unrelevant documents returned by queries, favoring recall decreases the amount of missing documents. |
| Name | Type | Default value | Description |
| language | iso code | - | The language handled by this tokenizer. This can be null for all unhandled languages. |
| Name | Type | Default value | Description |
| classId | string | - | The class identifier of the custom processor; this class must implement CustomTokenizerInterface. |
| Type | Wrapper | Description |
| KeyValue* | - |
| Type | Wrapper | Description |
| BuildPolicies | - | The build policies used to trigger a build of a dictionary. |
| CompactPolicies | - | The compact policies used to trigger dictionary compaction. |
| QueryConfig* | - | |
| ResourceConfig* | - | Resources that should be built for this dictionary, along with their configuration. |
| Name | Type | Default value | Description |
| disjunctives | boolean | True |
| Type | Wrapper | Description |
| BuildPolicy* | - | Specifies the build policies. |
| Name | Type | Default value | Description |
| countThreshold | int | 1 | Number of compacts that will trigger a compact. |
| Name | Type | Default value | Description |
| delayInS | long | 600 | Time in seconds between two builds. |
| Name | Type | Default value | Description |
| disjunctives | boolean | True |
| Type | Wrapper | Description |
| CompactFilter* | - | Filtering rules for data imported from the stream to be compacted. * CompactFrequencyFilter... |
| CompactPolicy* | - | Specifies the compact policies. |
| Name | Type | Default value | Description |
| minFrequency | long | 1 | Discards entries with frequency below this threshold |
| language | iso code | - | Language represented by its iso639-1 code, e.g: fr, en... |
| Name | Type | Default value | Description |
| countThreshold | int | 1 | Number of imports that will trigger a compact. |
| Name | Type | Default value | Description |
| delayInS | long | 600 | Time in seconds between two compacts. |
| Name | Type | Default value | Description |
| tokenizationConfig | string | - | |
| preAllocatedPipelines | int | - |
| Name | Type | Default value | Description |
| resourceURL | string | - | |
| name | string | - | |
| defaultList | boolean | False | Select the list to be used by default |
| Name | Type | Default value | Description |
| tokenizationConfig | string | - | |
| preAllocatedPipelines | int | - |
| Name | Type | Default value | Description |
| tokenizationConfig | string | - | |
| preAllocatedPipelines | int | - |
| Name | Type | Default value | Description |
| tokenizationConfig | string | - | |
| preAllocatedPipelines | int | - |
| Name | Type | Default value | Description |
| tokenizationConfig | string | - | |
| preAllocatedPipelines | int | - |
| Name | Type | Default value | Description |
| tokenizationConfig | string | - | |
| preAllocatedPipelines | int | - |
| Name | Type | Default value | Description |
| tokenizationConfig | string | - | |
| preAllocatedPipelines | int | - |
| Type | Wrapper | Description |
| LanguageConfig* | - |
| Name | Type | Default value | Description |
| language | iso code | - | Language represented by its iso639-1 code, e.g: fr, en... |
| maxTerm | long | 1000000 | Maximum number of terms kept |
| Type | Wrapper | Description |
| Filter* | - | Filtering rules for data imported from the stream to build this resource. * RegexpFilter, FrequencyFilter, CustomFilter ... |
| Name | Type | Default value | Description |
| regexp | string | - | Discards entries matching this regular expression |
| Name | Type | Default value | Description |
| minFrequency | long | 1 | Discards entries with frequency below this threshold |
| Type | Wrapper | Description |
| LanguageConfig* | - |
| Name | Type | Default value | Description |
| overallMaxTerm | long | 100000000 | Overall maximum number of terms kept regardless of the language |
| Type | Wrapper | Description |
| LanguageConfig* | - |
| Type | Wrapper | Description |
| LanguageConfig* | - |
| Type | Wrapper | Description |
| LanguageConfig* | - |
| Name | Type | Default value | Description |
| version | long | - | - |
| resourceDir | string | data:///build/resources | Path to master copy of all resources |
| Type | Wrapper | Description |
| ResourceGroup* | - |
| Name | Type | Default value | Description |
| name | string | - | Resource group name |
| roles | string | - | The list of roles on which the resource should be published (comma-separated). |
| waitOnSync | boolean | False |
| Type | Wrapper | Description |
| Resource* | - |
| Name | Type | Default value | Description |
| name | string | - | Name of the resource. |
| type | string | - | Type of the resource. |
| description | string | - | Short description of the resource. |
| author | string | - | Author of the resource. |
| applicationId | string | - | Application Id of the resource.
If defined, the resource can only be edited in this application. |
| converterClassId | string | - | Converter Class Id.
If defined, it will be used instead of the default converter associated with the resource type. |
| Type | Wrapper | Description |
| KeyValue* | - | Configuration of the resource. |
| Name | Type | Default value | Description |
| name | string | - | Name of the resource. |
| type | string | - | Type of the resource. |
| description | string | - | Short description of the resource. |
| author | string | - | Author of the resource. |
| applicationId | string | - | Application Id of the resource.
If defined, the resource can only be edited in this application. |
| converterClassId | string | - | Converter Class Id.
If defined, it will be used instead of the default converter associated with the resource type. |
| tokenizationConfig | string | - | Specify the tokenization config to use |
| Type | Wrapper | Description |
| KeyValue* | - | Configuration of the resource. |
| Name | Type | Default value | Description |
| version | long | - | - |
| login | string | - | Root login.
Can be used to connect to every secured UI. Also used for securing inter process communications when required. |
| password | string | - | Root password.
Encrypted using product RSA encryption key. |
| secureInternalConnections | boolean | False | Basic authentication using product login - password. |
| Type | Wrapper | Description |
| StringValue* | trustedHost | Hostnames allowed for redirection. "*" means any characters. For example, *.exalead.com would allow all hosts in the exalead.com domain. |
| IdentityProviderConfig* | - | |
| MAMISecurity | - | |
| PushAPISecurity | - | |
| SearchAPISecurity | - |
| Name | Type | Default value | Description |
| name | string | - | Identity provider name. |
| filterFactoryClassId | string | - | Optional classId of a specific FilterFactory to use instead of the default one. It is used to create a specific SecurityFilter to change the authentication method. |
| securitySource | string | - | Associated security source. |
| sessionInactivityTimeoutS | long | 21600 | Sessions will time out after this time. -1 for no timeout |
| Type | Wrapper | Description |
| KeyValue* | - |
| Name | Type | Default value | Description |
| login | string | - | Login.
Set to null to disable authentication. |
| password | string | - | Password.
Encrypted using product RSA encryption key. |
| useHttps | boolean | False | Secures connection with HTTPS. |
| serverCertificate | string | - | When using HTTPS, name of a sertificate inside the security folder of the data directory. When not provided the default certificate is used. |
| Type | Wrapper | Description |
| IPRule* | - |
| Name | Type | Default value | Description |
| allow | boolean | False | Allows the IP address access. |
| addr | string | - | Address. |
| mask | string | - | Mask. |
| Name | Type | Default value | Description |
| serverCertificate | string | - | When using HTTPS, name of a sertificate inside the security folder of the data directory. When not provided the default certificate is used. |
| useHttps | boolean | False | Secures connection with HTTPS. |
| Name | Type | Default value | Description |
| login | string | - | Login.
Set to null to disable authentication. |
| password | string | - | Password.
Encrypted using product RSA encryption key. |
| useHttps | boolean | False | Secures connection with HTTPS. |
| serverCertificate | string | - | When using HTTPS, name of a sertificate inside the security folder of the data directory. When not provided the default certificate is used. |
| Type | Wrapper | Description |
| IPRule* | - |
| Name | Type | Default value | Description |
| version | long | - | - |
| strictConfig | boolean | False | Stops deployment if a security source failed to initialize. |
| Type | Wrapper | Description |
| SecuritySourceBase* | - |
| Name | Type | Default value | Description |
| name | string | - | Security source name |
| deploy | boolean | True | Will this security source be deployed? |
| type | enum(First, Merge, No Authentication) | First | Type of action when an authentication succeeds Value can be null or one of
|
| forcedTokens | string | An optional comma-separated list of tokens which will be appended to all authenticated users. |
| Type | Wrapper | Description |
| AuthenticationSource* | - | List of sources on which authentication will be performed |
| AuthorizationSource* | - | List of sources for which token will be retrieved if an authentication has succeeded. |
| Name | Type | Default value | Description |
| name | string | - | The name of the security source. |
| rewrittenLogin | string | Can be used to rewrite the login. '$login' will be replaced by the user's login. For example, OFFICE\$login |
| Name | Type | Default value | Description |
| name | string | - | The name of the security source. |
| rewrittenLogin | string | Can be used to rewrite the login. '$login' will be replaced by the user's login. For example, OFFICE\$login | |
| passwordIsMandatory | boolean | False | Forces the password to match |
| Name | Type | Default value | Description |
| name | string | - | Security source name |
| deploy | boolean | True | Will this security source be deployed? |
| classId | string | - | Security source type |
| customClassId | string | - | Customized security source type |
| singleInstance | boolean | False | Will this source be deployed on each security command? |
| Type | Wrapper | Description |
| KeyValue* | config |
| Name | Type | Default value | Description |
| name | string | - | Security source name |
| deploy | boolean | True | Will this security source be deployed? |
| service | string | Service path on the remote security source | |
| isAlivePath | string | - | The path to determine if the service is available on hosts. Not used if null. |
| maxRetries | int | - | Number of retries before skipping an host |
| Type | Wrapper | Description |
| RemoteHttpConfig* | - | Hosts on which authentication will be performed |
| Name | Type | Default value | Description |
| protocol | enum(http, https) | http | Protocol of the remote security source host |
| host | string | - | Hostname of the remote security source |
| port | int | 80 | Port of the remote security source |
| power | int | 1 | Priority of this host |
| Name | Type | Default value | Description |
| version | long | - | - |
| dbConnectionString | string | jdbc:sqlite:${dataDir}/alerting/db.sql | JDBC connection string for the alerting database. |
| dbUsername | string | - | |
| dbPassword | string | - |
| Name | Type | Default value | Description |
| lastModifiedDate | long | - | |
| humanLastModifiedDate | long | 0 |
| Type | Wrapper | Description |
| AlertGroup* | - |
| Name | Type | Default value | Description |
| name | string | - | |
| description | string | - | |
| securitySource | string | - | Name of the security source to check tokens against when executing user alerts |
| application | string | - | Mashup application for this alert group |
| useAsDefault | boolean | False | Automatically selects this alert group in the "Save as alert" Mashup Widget. |
| publishDocumentMetas | boolean | True | When enabled, document metas are also published on match. It may be useful to disable this option to reduce gateway heap usage. |
| storeAlertOccurences | boolean | True | If set, each matching alert will be stored in the underlying alert_occurence table. |
| realTime | boolean | False | Matches alerts in this alert group as soon as the document is pushed
(real-time alerting). If false, matches alerts by executing scheduled queries (scheduled alerting). Real-time alerting offers very low latency alerting, but with fewer features. For details, see the CloudView Administration Guide. |
| autoBuild | boolean | True | Automatically rebuilds the real-time alerting matchers each time an alert is added, deleted, or
updated. Autobuild should be disabled for large alerting groups (thousands of alerts). |
| storeResults | boolean | False | Stores the results of each alert. Required for using the real-time alerts displayer; calculating the difference since the last alert trigger; and ensuring transaction consistency if a publication fails. |
| incremental | boolean | False | Includes a timestamp criteria with each alert request so the alert only returns documents modified or added since the
last alert trigger. Only applies to scheduled alerting groups, since real-time alerting groups are always incremental. |
| groupAlertsByUser | boolean | False | Groups all alerts for a user in a single publication. Only applies to scheduled alerting groups, since real-time alerting publications are never grouped. |
| Type | Wrapper | Description |
| AlertPublisher* | - | List of alert publisher configurations. |
| IncrementalModeConfig | - | Advanced configuration for the incrementality of scheduled alerting groups. |
| Scheduling | - | Defines the trigger rule for scheduled queries. Only applies to scheduled alerting groups. |
| Name | Type | Default value | Description |
| name | string | - | |
| classId | string | - | Publisher type |
| Name | Type | Default value | Description |
| name | string | - | |
| address | string | - | Publication endpoint address |
| format | string | atom | Alert publishing format. The only supported format is 'atom'. This is the native atom format of the Mashup API. It can be deserialized in Java by using, for example, the AccessClient. Additional information is added on the root feed, with alerting-specific data. |
| Name | Type | Default value | Description |
| name | string | - | |
| address | string | - | Publication endpoint address |
| format | string | json | Alert publishing format. The only supported format is 'json' |
| Name | Type | Default value | Description |
| name | string | - | |
| fromAddress | string | - | E-mail address that will appear as "From" in alerting mails. |
| toAddressFormat | string | - | Format string used to build the recipient e-mail address.
${USER} is automatically substituted with the login of the user. For example, if the format is "${USER}@mycompany.com", and "user1" sets up an alert, mails for this alert are sent to "user1@mycompany.com". |
| titleFormat | string | ${NB_RESULTS} results for your ${NB_ALERTS} alert(s) | |
| mailTemplateDirectory | string | resource:///alerting/mail/templates | |
| mailTemplate | string | default.ftl | |
| groupAlertsByUser | boolean | True | |
| feedToRender | string | cloudview | Name of the top-level feed to render. |
| Type | Wrapper | Description |
| StringValue* | metaToExpose | List of meta exposed in mail template. Metas "publicurl" and "lastmodifieddate" are exposed by default |
| SMTPServer | - |
| Name | Type | Default value | Description |
| analysisTimestampIndexField | string | analysisdate | |
| timestampRestrictionPageParameter | string | cloudview.eq.date_restriction | Name of the Mashup-API page parameter to send the ELLQL query for timestamp restriction |
| timestampOffsetS | long | 900 | Negative offset in seconds on the previous trigger timestamp, to account for the time delta between the moment a document is analyzed and the moment it is available for queries. |
| Name | Type | Default value | Description |
| cronExpression | string | - | |
| workerThreads | int | 1 |
| Name | Type | Default value | Description |
| name | string | - | Identifies this consolidation configuration uniquely |
| nbThreads | int | 4 | Number of threads to allocate during the transformation and aggregation phases. |
| maxNativeMemoryConsumptionThreshold | enum(disabled, enabled, auto) | enabled | When reaching the memory consumption value specified, transformation is stopped and transformed documents are committed. Then the transformation starts again.
|
| maxNativeMemoryConsumptionInMB | int | 2048 | The maximum of native memory the transformation service can allocate. Reaching this limit triggers a commit. |
| Type | Wrapper | Description |
| CommitTriggerCondition* | CommitTriggerConditions | |
| CommitTriggerCondition* | AggregationTriggerConditions | |
| AdvancedConfig | - | |
| AggregationForwardProcessorConfigList | - | |
| AggregationProcessorConfigList | - | |
| TransformationProcessorConfigList | - |
| Name | Type | Default value | Description |
| sequentialCompaction | boolean | True |
| Type | Wrapper | Description |
| AdvancedAggregationConfig | - | |
| CompactPolicies | - | |
| DocumentStoreWarnConfig | - |
| Name | Type | Default value | Description |
| impactQueueSize | int | 8 | |
| aggregationQueueSize | int | 8 | |
| forwardQueueSize | int | 1600 | |
| aggregatedVerticesCacheSize | int | 65536 | Deprecated since V6R2016xR4, a dedup on impact detection results is now performed before running the aggregation |
| vertexCacheSize | int | 65536 | |
| impactDetectionResultCacheMaxFileSizeInBytes | int | 10485760 | |
| logCountImpactedVertices | int | -1 | Possible values:
|
| metaCountLogThreshold | int | -1 | Possible values:
|
| disableCheckpointForwarding | boolean | False | |
| countCheckpointAsATask | boolean | True | |
| progressionSaveThresholdInMS | long | 3600000 |
| Name | Type | Default value | Description |
| thresholdInBytes | long | 104857600 | |
| enableAtTransformation | boolean | True | |
| enableAtAggregation | boolean | True |
| Type | Wrapper | Description |
| AggregationForwardProcessorConfig* | - |
| Name | Type | Default value | Description |
| pushAPIServer | string | - | Specify the target Push API server |
| documentTypes | string | - | Comma-separated list of document types to forward. Leave empty to match all documents. Deprecated since V6R2015x.SP4, replaced by ForwardedDocumentTypeList |
| triggerIndexing | boolean | True | If set to true (default behavior), it will trigger an indexing job on your remote Push API server when the aggregation job is complete |
| Type | Wrapper | Description |
| ForwardedDocumentTypeList | - |
| Type | Wrapper | Description |
| ForwardedDocumentType* | - |
| Name | Type | Default value | Description |
| type | string | - |
| Type | Wrapper | Description |
| CommonProcessorConfig* | - | Declare an aggregation processor to be used by the Consolidation Server. |
| Name | Type | Default value | Description |
| source | string | - | |
| name | string | - | Identifies this processor uniquely in the processing step |
| description | string | - | Description of this processor |
| enabled | boolean | True | |
| mime | string | - | Mime-type of the language used to define the processor. As of now, supported types are:
|
| perfMonitored | boolean | False | Show the processor statistics in the Monitoring Console. |
| context | string | - | Indicates the context in which the processing operation will occur
|
| code | string | - | Processor source code run on add/update operations. |
| Name | Type | Default value | Description |
| source | string | - | |
| name | string | - | Identifies this processor uniquely in the processing step |
| description | string | - | Description of this processor |
| enabled | boolean | True | |
| mime | string | - | Mime-type of the language used to define the processor. As of now, supported types are:
|
| perfMonitored | boolean | False | Show the processor statistics in the Monitoring Console. |
| context | string | - | Indicates the context in which the processing operation will occur
|
| classId | string | - | |
| pluginName | string | - | Deprecated since V6R2016x.R2, not used by the product so not replaced. |
| Type | Wrapper | Description |
| KeyValue* | config |
| Name | Type | Default value | Description |
| name | string | - | Identifies this processor uniquely in the processing step |
| description | string | - | Description of this processor |
| enabled | boolean | True | |
| mime | string | - | Mime-type of the language used to define the processor. As of now, supported types are:
|
| perfMonitored | boolean | False | Show the processor statistics in the Monitoring Console. |
| context | string | - | Indicates the context in which the processing operation will occur
|
| code | string | - | Processor source code run on add/update operations. |
| Name | Type | Default value | Description |
| name | string | - | Identifies this processor uniquely in the processing step |
| description | string | - | Description of this processor |
| enabled | boolean | True | |
| mime | string | - | Mime-type of the language used to define the processor. As of now, supported types are:
|
| perfMonitored | boolean | False | Show the processor statistics in the Monitoring Console. |
| context | string | - | Indicates the context in which the processing operation will occur
|
| classId | string | - | |
| pluginName | string | - | Deprecated since V6R2016x.R2, not used by the product so not replaced. |
| Type | Wrapper | Description |
| KeyValue* | config |
| Type | Wrapper | Description |
| CommonTransformationProcessorConfig* | - | Declare a transformation processor to be used by the Consolidation Server. |
| Type | Wrapper | Description |
| CustomConfig* | - |
| Name | Type | Default value | Description |
| name | string | - | Name of the custom configuration entry. |
| Type | Wrapper | Description |
| KeyValue* | - |
| Type | Wrapper | Description |
| CalendarConfig* | - | |
| JobConfigGroup* | - | |
| TriggerConfigGroup* | - |
| Name | Type | Default value | Description |
| name | string | - | Name of the calendar. |
| cronExpression | string | - | The Quartz Cron expression. |
| Name | Type | Default value | Description |
| name | string | - | Name of the calendar. |
| startTime | string | - | Time range start. |
| endTime | string | - | Time range end. |
| Name | Type | Default value | Description |
| name | string | - | Name of the calendar. |
| Type | Wrapper | Description |
| IntValue* | - |
| Name | Type | Default value | Description |
| name | string | - | Name of the calendar. |
| Type | Wrapper | Description |
| IntValue* | - |
| Name | Type | Default value | Description |
| name | string | - | Group name. |
| Type | Wrapper | Description |
| JobConfig* | - |
| Name | Type | Default value | Description |
| name | string | - | Job name. |
| Type | Wrapper | Description |
| DispatchMessage | - |
| Name | Type | Default value | Description |
| name | string | - | Group name. |
| Type | Wrapper | Description |
| TriggerConfig* | - |
| Name | Type | Default value | Description |
| name | string | - | Name of the trigger. |
| startTime | long | - | Start date for this trigger. |
| endTime | long | - | End date for this trigger. |
| jobGroupName | string | - | Job group for this trigger. |
| jobName | string | - | Job name for this trigger. |
| calendarName | string | - | Optional calendar name for this trigger (to exclude blocks of time), only applies to simple triggers |
| misfireInstruction | string | - | Action to execute when the trigger couldn't be fired. @refer to each trigger documentation for available misfire instructions. |
| repeatCount | int | - | Repeats count (if <0 , no limit). |
| repeatInterval | long | - | Repeats interval in milliseconds. |
| Name | Type | Default value | Description |
| name | string | - | Name of the trigger. |
| startTime | long | - | Start date for this trigger. |
| endTime | long | - | End date for this trigger. |
| jobGroupName | string | - | Job group for this trigger. |
| jobName | string | - | Job name for this trigger. |
| calendarName | string | - | Optional calendar name for this trigger (to exclude blocks of time), only applies to simple triggers |
| misfireInstruction | string | - | Action to execute when the trigger couldn't be fired. @refer to each trigger documentation for available misfire instructions. |
| cronExpression | string | - | Cron expression. |
| Type | Wrapper | Description |
| ValidatorGroup* | - |
| Name | Type | Default value | Description |
| name | string | - | Name of this group of validators. |
| autorun | boolean | True | Default way to run all the group's validators. Default set to true (meaning the group will be ran at apply config time). |
| Type | Wrapper | Description |
| Validator* | - | List of validators belonging to this group. |
| Name | Type | Default value | Description |
| classId | string | - | |
| name | string | - | Unique identifier of the validator. |
| autorun | boolean | True | True if validator is to be ran at apply configuration time. Otherwise, will only be ran manually. |
| Name | Type | Default value | Description |
| classId | string | - | |
| name | string | - | Unique identifier of the validator. |
| autorun | boolean | True | True if validator is to be ran at apply configuration time. Otherwise, will only be ran manually. |
| Type | Wrapper | Description |
| KeyValue* | - |
| Name | Type | Default value | Description |
| version | long | - | - |
| identityProvider | string | - | |
| useHttps | boolean | False | |
| serverCertificate | string | - |
| Type | Wrapper | Description |
| Role* | - |
| Name | Type | Default value | Description |
| name | string | - |
| Type | Wrapper | Description |
| Permission* | - |
| Name | Type | Default value | Description |
| id | string | - | |
| permission | string | - |
| Name | Type | Default value | Description |
| key | string | - | The name of the key |
| value | string | - | - |
| type | string | - | - |
| description | string | - | - |
| Type | Wrapper | Description |
| KeyValue* | - | - |
| Name | Type | Default value | Description |
| value | string | - | - |
| Name | Type | Default value | Description |
| value | string | - | - |
| Name | Type | Default value | Description |
| value | int | - | - |
| Name | Type | Default value | Description |
| serviceName | string | - | - |
| messageName | string | - | - |
| outputFormat | string | - | - |
| Type | Wrapper | Description |
| KeyValue* | messageContent | - |