Run Lua Scripts

IDOL Connectors can run custom scripts written in Lua, an embedded scripting language. You can use Lua scripts to process documents that are created by a connector, before they are sent to CFS and indexed into IDOL Server. For example, you can:

  • Add or modify document fields.
  • Manipulate the information that is indexed into IDOL.
  • Call out to an external service, for example to alert a user.

There might be occasions when you do not want to send documents to a CFS. For example, you might use the Collect action to retrieve documents from one repository and then insert them into another. You can use a Lua script to transform the documents from the source repository so that they can be accepted by the destination repository.

To run a Lua script from a connector, use one of the following methods:

  • Set the IngestActions configuration parameter in the connector’s configuration file. For information about how to do this, see Run a Lua Script using an Ingest Action. The connector runs ingest actions on documents before they are sent for ingestion.
  • Set the IngestActions action parameter when using the Synchronize action.