Web Connector 25.2
Web Connector Help

# IngestBatchActions

The `IngestBatchActions` parameter specifies actions to perform after documents have been successfully sent to the ingestion server.

These actions run after documents have been sent to the ingestion server, so any changes to a document are not sent to CFS or to your Content component. You can use this parameter to run Lua scripts for reporting purposes.

Specify the value of this parameter in one of the following formats:

- `<BATCH_ACTION_TYPE>:<INGEST_TYPES_CSV>:<PARAMETERS>`
- `<BATCH_ACTION_TYPE>:<PARAMETERS>`

where,

- `<BATCH_ACTION_TYPE>` specifies the action to run. The possible actions are:

  `LUA` | Run a Lua script.

- `<INGEST_TYPES_CSV>` is an optional comma-separated list of document types to include in the action. If you do not specify the document types to include, the action includes all documents that were successfully sent to the ingestion server:

  `Add` | Include documents being added. Documents are added when the connector finds new items in the repository that it has not seen before, or when the content of a document has changed.
  `Delete` | Include documents being deleted. Documents are deleted when they no longer exist in the repository, or when their content has changed.
  `Update` | Include documents being updated. If the connector supports metadata-only updates, documents are updated when their content is the same but their metadata has changed.

- `<PARAMETERS>` specifies further information required by the action type:

  `LUA` | Specify the path to the script.

To specify more than one action use a comma-separated list, or use numbered `IngestBatchActions` parameters.

Type: | String
Default: |
Required: | No
Configuration Section: | TaskName or Ingestion
Example: |
    IngestBatchActions=LUA:myScript.lua
(or)
    IngestBatchActions0=LUA:Add,Update:myScript.lua
    IngestBatchActions1=LUA:Delete:myScript_deletes.lua
See Also: | IngestActions

Copyright 2025 Open Text
Version 25.2 | Last updated April 2025

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 Web Connector 25.2

Topic Title: IngestBatchActions