Jama Connector 23.4

# parse_document_idx

Parses an IDX file into documents and calls a function on each document.

## Syntax

    parse_document_idx( filename, handler )

## Arguments

Argument | Description
--- | ---
`filename` | (string) The path of the IDX file to parse into documents.
`handler` | (document_handler_function) The function to call on each document that is parsed from the IDX file. The function must accept a LuaDocument as the only argument.

## Example

The following example uses the `parse_document_idx` function to parse an IDX file, and calls the function `appendDocumentReference` on each document.

    local references = {}

    function appendDocumentReference(document)
        table.insert(references, document:getReference())
    end

    function read_idx_references(filename)
        parse_document_idx(filename, appendDocumentReference)
        return references
    end

## Returns

Nothing.

Copyright 2023 Open Text
Version 23.4 | Last updated September 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 swpdl.idoldocsfeedback@microfocus.com.

We appreciate your feedback!

Product: IDOL Jama Connector 23.4

Topic Title: parse_document_idx