OpenText Connector 26.3
OpenText Connector Help

# RequireDocumentCrawlLua

The path of a Lua script to run, to decide whether to crawl an item's descendents or ignore them.

NOTE: To use this functionality in NiFi, set the advanced connector property `adv:RequireDocumentCrawlLua`. You can set the value to either a script file path or the content of the script. OpenText recommends setting this property from the guided setup wizard, on the advanced configuration page, because the wizard provides useful examples.

The script has access to document metadata that has been retrieved by the connector, so if the connector configuration parameters do not provide sufficient flexibility you can add any custom content selection logic that you require.

The connector runs the script before binary files are downloaded, so excluding items in this way is more efficient that allowing the connector to retrieve them and then discarding them later in the ingest pipeline.

The script must contain a function named `handler`, that should return `true` to crawl the item or `false` to ignore it.

Copy

    function handler(config, document, params)
        local required = true
        -- required = filtering logic

        return required
    end

Type: | String
Default: |
Required: | No
Configuration Section: | TaskName or FetchTasks
Example: | `RequireDocumentLua=filter-items-to-crawl.lua`
See Also: |

Copyright 2026 Open Text
Version 26.3 | Last updated July 2026

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to MFI-swpdl.idoldocsfeedback@opentext.com.

We appreciate your feedback!

Product: Knowledge Discovery OpenText Connector 26.3

Topic Title: RequireDocumentCrawlLua