FTRBulkIndex client API - SmartPlant Foundation - IM Update 46 - Help - Hexagon

SmartPlant Foundation Help

Language
English
Product
SmartPlant Foundation
Search by Category
Help
SmartPlant Foundation / SDx Version
10
SmartPlant Markup Plus Version
10.0 (2019)
Smart Review Version
2020 (15.0)

The FTRBulkIndex client API is used to create an FTR Bulk Indexing scheduler task to index objects of selected criteria.

Argument

Description

Parameter 1

Classification UIDs

Parameter 1 default

DC_Document_category_1

Parameter 1 description

UIDs of Classifications to be displayed in the Classification tab

Parameter 1 type

String

Parameter 2

Type of objects to be indexed

Parameter 2 default

NOT_INDEXED

Parameter 2 description

Type of objects to be indexed with selected criteria. The options are NOT_INDEXED, FAILED_INDEXING, and INDEX_ALL.

Parameter 2 type

String

Parameter 3

Process deleted objects

Parameter 3 default

False

Parameter 3 description

If this option is selected, a bulk indexing scheduler task is created to index the deleted objects.

Parameter 3 type

Boolean

The FTRBulkIndex method uses the FTRBulkIndex client API to create an FTR Bulk Indexing scheduler task.