Connector Framework Server 24.1

# Lua Scripts Included With CFS

The CFS installation directory includes a `scripts` folder that includes the following Lua scripts:

Script | Description
--- | ---
`AddLanguageDetectionFields.lua` | Detects the language of a document’s content, using the IDOL Server action `DetectLanguage`. The script then adds fields describing the language and encoding to the document’s metadata. The script demonstrates how to: send an action to an ACI server. parse the action response to a `LuaXmlDocument`. use the methods of `LuaXmlDocument` to extract data from the document. The script assumes that an IDOL Server is installed on the local machine with an ACI port of 9000. You might need to modify these values. If you use this script, run it as a post import task so that it runs after KeyView has extracted document content.
`CategorySuggestFromText.lua` | Sends a document to IDOL for categorization, and adds information about the matching categories to the document's metadata. For information about how to use this script, see Categorize Documents.
`filterdodgyfiles.lua` | An example script that demonstrates various ways to reject unwanted files, for example by file extension, by detecting the file format, or by analyzing the file content.
`identifiers.lua` | Adds sub-file indexes to the `AUTN_IDENTIFIER` document field of sub-files. This allows a connector to retrieve the sub-file, rather than the whole container, when the `collect` or `view` actions are used to retrieve the original file. If you use this script, you must run it as a post import task (so that it runs after KeyView processes the documents). For more information about the `AUTN_IDENTIFIER` field, see AUTN_IDENTIFIER.
`mediaserver/*.lua` | These scripts run analysis on images, audio files, and video files by sending them to Media Server. For information about configuring media analysis, see Analyze Media.

NOTE: CFS also includes scripts for use with Eduction. Some of these scripts are Eduction post processing scripts, which modify the output from an Eduction import task. The post processing scripts have the entry point `function processmatch (edkmatch)`, rather than `function handler (document)`. You must run a post processing script using the Eduction import task. Do not run an Eduction post processing script using a Lua task. For more information about Eduction Lua Post Processing, see Lua Post Processing. For information about the Eduction scripts that are included with CFS, refer to the Eduction User Guide.

Copyright 2023 Open Text
Version 24.1 | Last updated December 2023

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: IDOL Connector Framework Server 24.1

Topic Title: Lua Scripts Included With CFS