Connector Framework Server 25.4
Connector Framework Server Help

# ingest

The `ingest` function sends a new document or file to CFS for ingestion. This function differs from `import_into_this_document` because it creates a new document, which is added to the ingest queue.

NOTE: CFS runs Pre and Post import tasks for the new document. For this reason, do not write a Lua script that calls the `ingest` function without using a condition to prevent the document being continuously ingested.

## Syntax

    ingest( filename [, isTemporary] )

    ingest( doc [, filename [, isTemporary]] )

## Arguments

Argument | Description
--- | ---
`doc` | (LuaDocument) The document to send for ingestion.
`filename` | (string) The name of a file to send for ingestion.
`isTemporary` | (boolean) Specifies whether the file is deleted after ingestion. By default, the file is not deleted (`false`).

## Returns

Boolean. Always returns `true`.

Copyright 2025 Open Text
Version 25.4 | Last updated October 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 Connector Framework Server 25.4

Topic Title: ingest