indexOptionEnum
Provides the list of index options.
References
- Used by the following properties:
bibus » indexOption » name
What's new
- New in Version 8.3 — Search — For Internal Use Only
Documentation for services, classes, methods, and enumeration values related to search integration has been updated to indicate that they are included to support internal functionality only. Do not use these extensions.
Members
- excludedObjects
Specifies the list of objects that the index update task excludes. The descendants of the objects are also excluded. An object is included if it, or any of its ancestors, are specified by the includedObjects option.
If an object was previously indexed and it is then excluded using this option, the object is removed from the index when the index update task is run.
To specify this option, use the bibus » indexOptionSearchPathMultipleObjectArray class.
Default: No objects are excluded from the index when the index update task is run.
- New in Version 8.4 — Index Options
This value was added.
- New in Version 10.1.0 — Previously Reserved Index Options Now Available for Client Use
This item, previously marked as "Reserved", is now available for client use.
- force
Specifies that the operation must proceed. This ignores any caching or optimizations, for example, based on the modification date of the document to be indexed or other factors. To specify this option, use the bibus » indexOptionBoolean class.
Default:
false- New in Version 10.1.0 — Previously Reserved Index Options Now Available for Client Use
This item, previously marked as "Reserved", is now available for client use.
- includedObjects
Specifies the list of objects included by the index update task. The descendants of the specified objects are indexed unless they are specified by the excludedObjects option. To specify this option, use the bibus » indexOptionSearchPathMultipleObjectArray class.
Default: All objects are included in the index by the index update task.
- New in Version 8.4 — Index Options
This value was added.
- New in Version 10.1.0 — Previously Reserved Index Options Now Available for Client Use
This item, previously marked as "Reserved", is now available for client use.
- indexModeledData
Specifies that all data in the models in scope of the indexing task are indexed. To specify this option, use the bibus » indexOptionBoolean class.
Default:
false- New in Version 10.1.0 — Data Collection Options for Indexing Tasks
This value was added.
- indexObjectTypes
Specifies that properties, metadata, and related objects (for example, output) for objects that are in scope of the indexing task and have been selected as indexable types are indexed. To specify this option, use the bibus » indexOptionBoolean class.
Default:
false- New in Version 10.1.0 — Data Collection Options for Indexing Tasks
This value was added.
- indexReferencedData
Specifies that only data referenced by expressions in objects in scope of the indexing task are indexed. Model objects in scope are ignored. To specify this option, use the bibus » indexOptionBoolean class.
Default:
false- New in Version 10.1.0 — Data Collection Options for Indexing Tasks
This value was added.
- maximumDocuments
Reserved.
- returnLocales
Reserved.
- returnSourceDocument
Reserved.
- returnTerms
Reserved.