import_into_this_document

The import_into_this_document function imports the content of a file into a document.

TIP: CFS uses KeyView to filter text from the file that you specify, and then adds the text to the DRECONTENT field of the document passed into the function. The text is not processed by pre- and post- import tasks that you have configured. If you specify a container file, CFS does not extract sub-files.

To create a new document, so that sub-files are extracted and so that CFS runs pre- and post-import tasks on the data, use the ingest function to create a new document and add it to the ingest queue.

Syntax

import_into_this_document( doc, filename_specifier )

Arguments

Argument Description
doc (LuaDocument) The document into which you want to import additional content.
filename_specifier

(string) The content that you want to import into the document. You can specify:

  • the path of the file that you want to import.
  • the name of a document field that contains the file path.
  • the name of a document field that contains a URL.

    TIP: You might need to set additional configuration parameters so that CFS can access the URL. To specify a proxy server, SSL/TLS settings, or authentication details, set the relevant parameters (for example ProxyHost, ProxyPort, ProxyUsername, ProxyPassword, BasicUsername, BasicPassword, and so on) in the [Default] section of the CFS configuration file.

  • the name of a section in the CFS configuration file that contains the settings to use for importing the content. For information about the configuration parameters you can set in this section, see ImportFile Task Parameters.

Returns

Boolean. Always returns true.

Example

The following example imports the content of a file into the document. The path or URL to the file is specified in a document field named MyField.

import_into_this_document(document, "MyField")