|
FTRBulkIndex client API |
|
|---|---|
|
Name |
FTRBulkIndex |
|
Description |
Used to create an FTR Bulk Indexing scheduler task to index objects of selected criteria |
|
Parameter 1 |
Classification UIDs |
|
Parameter 1 description |
UIDs of Classifications to be displayed in the Classification tab |
|
Parameter 1 type |
String |
|
Parameter 1 default |
DC_Document_category_1 |
|
Parameter 2 |
Type of objects to be 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 2 default |
NOT_INDEXED |
|
Parameter 3 |
Process deleted objects |
|
Parameter 3 description |
If this option is selected, a bulk indexing scheduler task is created to index the deleted objects. |
|
Parameter 3 type |
Boolean |
|
Parameter 3 default |
False |
|
FTRConfig client API |
|
|---|---|
|
Name |
FTRConfig |
|
Description |
FTR Configuration |
|
FTRReport client API |
|
|---|---|
|
Name |
FTRReport |
|
Description |
Indexing Status Report |
|
FTRRHMConfig client API |
|
|---|---|
|
Name |
FTRRHMConfig |
|
Description |
Configure component schema for FTR |
|
Parameter 1 |
EdgeDef / RelDef UID |
|
Parameter 1 type |
String |
|
Parameter 2 |
Property value |
|
Parameter 2 description |
Used to determine if FTR is enabled |
|
Parameter 2 type |
Boolean |
|
Parameter 2 default |
True |
|
Parameter 3 |
Apply to all properties |
|
Parameter 3 description |
Applies to all the properties on the Class Definition |
|
Parameter 3 type |
Boolean |
|
Parameter 3 default |
False |
|
FTRSearch client API |
|
|---|---|
|
Name |
FTRSearch |
|
Description |
Find an Object using FTR |
|
Parameter 1 |
Classification UIDs |
|
Parameter 1 description |
UIDs of Classifications to be displayed in the Classification tab |
|
Parameter 1 type |
String |
|
Parameter 2 |
Show advanced search criteria |
|
Parameter 2 description |
Display advanced search criteria |
|
Parameter 2 type |
Boolean |
|
Parameter 2 default |
False |
|
Parameter 3 |
Paged query size |
|
Parameter 3 description |
Enter a value to identify the page size; if not specified, normal query will be used |
|
Parameter 3 type |
Integer |
|
Parameter 3 default |
50 |
|
Parameter 4 |
Enable show for all paged |
|
Parameter 4 description |
For paged queries, this option enables the Show All button, which allows the user to get all data |
|
Parameter 4 type |
Boolean |
|
Parameter 4 default |
|
|
Parameter 5 |
Honor query limit for paged |
|
Parameter 5 description |
For paged queries, if this option is set to True, the maximum query limit is applied to the query |
|
Parameter 5 type |
Boolean |
|
Parameter 5 default |
|
|
Parameter 6 |
Select InterfaceDef to filter |
|
Parameter 6 description |
When searching complex document objects, select an interface definition to filter |
|
Parameter 6 type |
String |
|
Parameter 6 default |
ISPFDocumentVersion |
|
Parameter 7 |
Enable Content Search by default |
|
Parameter 7 description |
If set to True, FTR Search includes properties and contents. Otherwise, FTR Search will look for properties only |
|
Parameter 7 type |
Boolean |
|
Parameter 7 default |
False |
|
FTRPreview client API |
|
|---|---|
|
Name |
FTRPreview |
|
Description |
Find an object using FTR Preview |
|
Parameter 1 |
Paged query size |
|
Parameter 1 description |
Enter a value to identify the page size, the normal query size will be used if not specified |
|
Parameter 1 type |
Integer |
|
Parameter 1 default |
50 |
|
Parameter 2 |
Enable show all for paged |
|
Parameter 2 description |
The Show All button will be enabled when using paged queries, which allows the user to get all of the results |
|
Parameter 2 type |
Boolean |
|
Parameter 2 default |
False |
|
Parameter 3 |
Honor query limit for paged |
|
Parameter 3 description |
If set to True, the user’s maximum query limit will be applied to paged queries |
|
Parameter 3 type |
Boolean |
|
Parameter 3 default |
False |
|
Parameter 4 |
Enable light list view for paged |
|
Parameter 4 description |
If set to True, the light list view will be enabled when using paged queries, which allows the user to get the results quicker |
|
Parameter 4 type |
Boolean |
|
Parameter 4 default |
False |
|
Parameter 5 |
Select InterfaceDef to filter |
|
Parameter 5 description |
Defines the interface definition to filter by when searching for complex objects |
|
Parameter 5 type |
String |
|
Parameter 5 default |
|