Open topic with navigation

# General Functions

Function | Description
--- | ---
abs_path | Returns the supplied path as an absolute path.
base64_decode | Decodes a base64-encoded string.
base64_encode | Base64-encodes a string.
convert_date_time | Converts date and time formats using standard IDOL date formats.
convert_encoding | Converts the encoding of a string from one character encoding to another.
copy_file | Copies a file.
create_path | Creates the specified directory tree.
create_uuid | Creates a universally unique identifier.
delete_file | Deletes a file.
delete_path | Deletes a specified directory, but only if it is empty.
doc_tracking | Raises a document tracking event for a document.
encrypt | Encrypts a string.
encrypt_security_field | Encrypts the ACL.
extract_date | Searches a string for a date and returns the date.
file_setdates | Modifies the properties of a file (for example created date, last modified date).
get_config | Loads a configuration file.
get_log | (Deprecated) Returns a LuaLog object that provides the capability to write log messages.
get_log | Returns a LuaLog object that provides the capability to write log messages.
get_log_service | Obtains a LuaLogService object, from which you can obtain a LuaLog object that you can use to write messages to a log file.
get_task_config | Returns a LuaConfig object that contains the configuration of the fetch task that called the script.
get_task_name | Returns the name of the fetch task that called the script.
getcwd | Returns the current working directory of the application.
gobble_whitespace | Reduces multiple adjacent while spaces.
hash_file | Hashes a file using the SHA1 or MD5 algorithm.
hash_string | Hashes a string.
is_dir | Checks if the supplied path is a directory.
log | Appends log messages to a file.
move_file | Moves a file.
parse_csv | Parse comma-separated values into individual strings.
parse_document_csv | Parse a CSV file into documents and call a function on each document.
parse_document_idx | Parse an IDX file into documents and call a function on each document.
parse_document_idx | Parse an IDX string or file and return a LuaDocument.
parse_document_xml | Parse an XML file into documents and call a function on each document.
parse_document_xml | Parse an XML string or file and return a LuaDocument.
parse_json | Parse a string of JSON data and return a LuaJsonValue.
parse_json_array | Parse a string of JSON data (that is a JSON array) and a return a LuaJsonArray.
parse_json_object | Parse a string of JSON data (that is a JSON object) and return a LuaJsonObject.
parse_xml | Parse XML string to a LuaXmlDocument.
regex_match | Performs a regular expression match on a string.
regex_replace_all | Searches a string for matches to a regular expression, and replaces the matches.
regex_search | Performs a regular expression search on a string.
script_path | Returns the path and file name of the script that is running.
send_aci_action | Sends a query to an ACI server.
send_aci_command | Sends a query to an ACI server.
send_and_wait_for_async_aci_action | Sends a query to an ACI server and then waits for the action to finish. Use this method for sending asynchronous actions so that the action response is returned instead of a token.
send_http_request | Sends an HTTP request.
sleep | Pauses the running thread.
unzip_file | Extracts the contents of a zip file.
url_escape | Percent-encode a string.
url_unescape | Replaces URL escaped characters and returns a standard string.
xml_encode | Takes a string and encodes it using XML escaping.
zip_file | Zips the supplied path (file or directory).

© Copyright 2019 Micro Focus or one of its affiliates | Send documentation feedback Close Send documentation feedback To open the configured email client on this computer, open an email window. Otherwise, copy the information below to a web mail client, and send this email to swpdl.idoldocsfeedback@microfocus.com. We appreciate your feedback! Product: Topic Title: Help Topic: Feedback:

_FT_HTML5_bannerTitle.htm