PutIDOL

Indexes documents into IDOL Server.

Properties

Name Default Value Description
IDOL License Service  

An IdolLicenseServiceImpl that provides a way to communicate with an IDOL License Server.

IDOL Host   The host name or IP address of the machine hosting the IDOL Content component.
IDOL ACI Port   The IDOL Content component ACI port.
SSL Config Service   An optional IdolSSLConfigServiceImpl that specifies the settings to use to index documents over SSL/TLS. Set this property if your IDOL Content component has been configured to accept connections over SSL.
Document Registry Service   A DocumentRegistryServiceImpl controller service that manages and updates a document registry database. This ensures that documents are indexed in the correct order.
Indexer Batch Size 100

The maximum number of FlowFiles to accumulate before indexing documents.

Indexing documents in larger batches can be more efficient; indexing smaller batches more frequently means that an individual document might spend less time in the queue.

Documents might be indexed in incomplete batches if the Indexing Interval Duration is reached first.

Compress Index Files False A Boolean value that specifies whether to compress index files before they are sent to IDOL.
Create IDOL Database False A Boolean value that specifies whether to add the action parameter CreateDatabase=TRUE to index actions that are sent to IDOL. This instructs IDOL to create databases that do not already exist.
Default IDOL Database Name   The name of the IDOL database to index a document into when the DREDBNAME field is not set. DREDBNAME is a document field that specifies the name of the IDOL database to index a document into.
GSSAPI Service Name   The GSSAPI service name for the IDOL Content server (used in Kerberos authentication environments only).
Indexing Interval Duration 5 min

The maximum amount of time to wait between indexing batches of documents. Documents might be indexed more frequently than this if the Indexer Batch Size is reached first.

Waiting longer and indexing documents in larger batches can be more efficient; indexing smaller batches more frequently means that an individual document might spend less time in the queue.

Index Over Socket True

A Boolean value that specifies whether data is sent over a network or is indexed locally.

  • Use the value true when the IDOL Server is installed on a different computer and documents must be indexed over a network.
  • Use the value false when the IDOL Server is installed on the same host as NiFi and documents are indexed locally. In this case, the processor uses a DREADD index action. File-based indexing using DREADD is quicker, but the documents must be on the same machine as IDOL, or on a network share that IDOL has permission to access.
Index Priority -1 The priority to use in index actions sent to IDOL. Specify an integer from 0 to 100, where 0 is the lowest priority and 100 is the highest. IDOL processes index actions in order of priority. The default value (-1) means that no priority is specified in the index action and the default priority is assigned by IDOL.
Keep Existing Documents False

The value to use for the KeepExisting action parameter in index actions sent to IDOL to add new documents.

KeepExisting determines how IDOL handles documents when a document sent for indexing matches a document already in IDOL. For information about how to set this parameter, refer to the IDOL Server Reference.

Kill Duplicate Documents

The value to use for the KillDuplicates action parameter in index actions sent to IDOL to add new documents.

If you do not set this property, the KillDuplicates action parameter is not set.

KillDuplicates determines how IDOL identifies and handles duplicate documents. For information about how to set this parameter, refer to the IDOL Server Reference.

Replace All References False

The value to use for the ReplaceAllRefs action parameter in index actions sent to IDOL to replace existing documents.

ReplaceAllRefs determines which documents are replaced when more than one matching document is found. For more information about this parameter, refer to the IDOL Server Reference.

Use XML Indexing False Specifies whether to index documents in XML format. To preserve the tags and structure of XML content when it is indexed into IDOL, set this property to true.
XML Document Tag DOCUMENT The name to use for the XML nodes that delimit documents in a batch of documents to be indexed. You can change the name of this node if you have configured custom document separators in your IDOL Content component. This property is used only when Use XML Indexing is true.
XML Root Tag DOCUMENTS The name to use for the root XML node in a batch of documents to be indexed. You can change the name of the root node if you have configured a custom node name in your IDOL Content component. This property is used only when Use XML Indexing is true.
IDX - Use XML Safe Field Values false

Some control characters cannot be represented in XML format because they are forbidden by the XML specification. When you set this parameter to TRUE, characters in document fields that are forbidden in XML are replaced with spaces.

This parameter applies only when you index documents in IDX format. When you index documents in XML format, the forbidden characters are always replaced by spaces.

Relationships

Name Description
success FlowFiles that were indexed successfully.
failure FlowFiles that failed to be indexed (the IDOL Content component returned an error).